From 1c252705030a155df302133f432da624efb31ed5 Mon Sep 17 00:00:00 2001 From: jbarlow83 Date: Tue, 28 Jul 2015 17:55:56 -0700 Subject: [PATCH] Improve instructions for users that need sudo or venv --- README.rst | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 0a112711..dd4f1e35 100644 --- a/README.rst +++ b/README.rst @@ -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.