From 11c95fb26c2ece254e7f4ef68cfc6e6db64de76e Mon Sep 17 00:00:00 2001 From: decentral1se Date: Wed, 29 Mar 2023 18:46:27 +0200 Subject: [PATCH] docs: getting started from scratch --- command-line/README.md | 13 ++++++++----- command-line/requirements.txt | 7 +++++++ 2 files changed, 15 insertions(+), 5 deletions(-) create mode 100644 command-line/requirements.txt diff --git a/command-line/README.md b/command-line/README.md index 5486fe9..d67efb3 100644 --- a/command-line/README.md +++ b/command-line/README.md @@ -27,8 +27,11 @@ It saves it as a HTML page, which can be turned into a PDF with Paged.js. ## How to use it? -1. Change the `wiki` and `pagename` variables in `update.py` on line 221 + 222. -2. Copy paste your CSS into print.css -3. Run `$ python3 update.py` -4. Run `$ make` -5. Open `localhost:8000` in your browser +1. Change the `wiki` and `pagename` (e.g. `Pdf:Foobar`) variables in `update.py` on line 221 + 222. +1. Copy paste your CSS into print.css +1. `python3 -m venv .venv && source .venv/bin/activate` +1. `pip install -r requirements.txt` +1. Run `import nltk; nltk.download('punkt')` in a `python3` interpreter +1. Run `$ python3 update.py` +1. Run `$ make` +1. Open `localhost:8000` in your browser diff --git a/command-line/requirements.txt b/command-line/requirements.txt new file mode 100644 index 0000000..b044b3f --- /dev/null +++ b/command-line/requirements.txt @@ -0,0 +1,7 @@ +click==8.1.3 +Jinja2==3.1.2 +joblib==1.2.0 +MarkupSafe==2.1.2 +nltk==3.8.1 +regex==2023.3.23 +tqdm==4.65.0 -- 2.39.2