aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2015-11-12 22:02:37 -0500
committerTeddy Wing2015-11-12 22:38:45 -0500
commit135614ecefd3bcbc22bdcc07a2649fdbef8c41a0 (patch)
treebd170d2b85376c9f780c4c8192ee64e6e9c9fb16
parent0fcf79a66b6276002874118da6d0e5d9da01e3bc (diff)
downloadtrufont-135614ecefd3bcbc22bdcc07a2649fdbef8c41a0.tar.bz2
INSTALL.md: Add Virtualenv information
For those wanting to use Virtualenv, we need to make sure that the `--system-site-packages` flag is passed in when creating it. Otherwise the PyQt5 package won't be accessible since it needs to be installed using Homebrew or Apt. Doing so installs PyQt5 to the system Python where it isn't accessible from a normal Virtualenv.
-rw-r--r--INSTALL.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
index c35437e..b9e9cd3 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -98,3 +98,11 @@ If you installed TruFont with `setup.py`, it can be uninstalled with this comman
(be careful with rm!):
cat installed-files.txt | xargs sudo rm --verbose -vr
+
+# Virtualenv
+
+[Virtualenv](https://virtualenv.pypa.io) is optional. If you plan to use it and you've installed
+PyQt5 with Homebrew or Apt, then add the `--system-site-packages` flag when creating the Virtualenv
+to make PyQt5 available:
+
+ virtualenv --system-site-packages virutalenv-name