Improve instructions for users that need sudo or venv

This commit is contained in:
jbarlow83
2015-07-28 17:55:56 -07:00
parent 47e50f82c4
commit 1c25270503
+15 -6
View File
@@ -49,18 +49,27 @@ Install
Download OCRmyPDF here: https://github.com/fritz-hh/OCRmyPDF/releases
To install, download the tarball and run::
pip3 install ocrmypdf-3.0rc2.tar.gz
You can install it within a virtual environment or system-wide.
To install the HEAD revision from sources in development mode if you want
to make changes::
To install the HEAD revision from sources in development mode::
git clone -b master https://github.com/fritz-hh/OCRmyPDF.git
cd OCRmyPDF
pip3 install -e .
On certain Linux/UNIX platforms such as Ubuntu, you may need to use
run the install command as superuser::
sudo pip3 install -e .
Note that this will alter your system's Python distribution. If you prefer
to not install as superuser, you can install the package in a Python virtual environment::
git clone -b master https://github.com/fritz-hh/OCRmyPDF.git
pyvenv venv
source venv/bin/activate
cd OCRmyPDF
pip3 install -e .
If your platform does not have ``pip3``, make sure that Python 3.4+ and the `pip`
package are installed.