aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2019-08-19 18:48:57 +0100
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2019-08-19 18:50:20 +0100
commit44c0c45435f608d2880b19083d31d9af1945fd30 (patch)
tree0358b71fbcae0d93cc0e19448b53a1cf688972a1 /README.md
parentAdd unit test for Springer Provider (diff)
downloadpaper2remarkable-44c0c45435f608d2880b19083d31d9af1945fd30.tar.gz
paper2remarkable-44c0c45435f608d2880b19083d31d9af1945fd30.zip
Update readme and bump versionv0.3.2
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index 0cb0f36..d6de670 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ any of the following sources:
- an ACM citation page url (``https://dl.acm.org/citation.cfm?id=...``)
- an OpenReview paper (either ``openreview.net/forum?id=...`` or
``openreview.net/pdf?id=...``)
+- a Springer paper url (either to the HTML or the PDF)
- a url to a PDF file
- a local file.
@@ -106,11 +107,15 @@ The script also needs the following Python packages:
- [titlecase](https://pypi.org/project/titlecase/): fancy titles
- [pdfplumber](https://github.com/jsvine/pdfplumber): used for better page
cropping
+- [unidecode](https://pypi.org/project/Unidecode/): clean accented characters
+ from the filename
-You can use this line:
+If you use [Poetry](https://poetry.eustace.io/) you can install these
+dependencies using ``poetry install`` in the project directory. Alternatively,
+you can use ``pip`` with the following command:
```bash
-pip install --user bs4 requests PyPDF2 titlecase pdfplumber
+pip install --user bs4 requests PyPDF2 titlecase pdfplumber unidecode
```
# Notes