recommend the use of a venv

soulisalmed · Apr 16, 2020 · 95e8fb0 · 95e8fb0
1 parent 7387aa8
commit 95e8fb0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -18,17 +18,26 @@ biff requires the following modules :
   * numpy
   * odfpy
 
-biff needs Python 3
+biff needs Python 3/pip3
 
 ```
-$ git clone https://github.com/soulisalmed/biff.git			
-$ cd biff		
-$ pip3 install -r requirements.txt					
-$ python3 -m biff my_highlighted.pdf			
+$ git clone https://github.com/soulisalmed/biff.git					
+```			
+Install the dependencies. It is recommended to use a virtual environment:
+```
+$ cd biff
+$ python3 -m venv venv
+$ source ./venv/bin/activate
+$ pip install -r requirements.txt	
+```		
+To run Biff :
+```		
+$ source <biff folder>/venv/bin/activate				
+$ python -m biff my_highlighted.pdf			
 ```
 Usage:
 ```
-usage: __main__.py [-h] [-c] [-q QUALITY] [pdf [pdf ...]]
+usage: biff [-h] [-c] [-q QUALITY] [pdf [pdf ...]]
 
 Extract highlighted text and framed images from PDF(s) generated with
 reMarkable tablet to Openoffice text document. Highlighted text will be

diff --git a/requirements.txt b/requirements.txt
@@ -2,4 +2,4 @@ defusedxml==0.6.0
 numpy==1.18.2
 odfpy==1.4.1
 opencv-python==4.2.0.34
-PyMuPDF==1.16.16
+PyMuPDF==1.16.17