Merge pull request MariaDB#2 from fauust/setup-prod

Improve documentation for Linux installation

.gitignore

@@ -1,5 +1,6 @@
 *.exe
 *.py[cod]
+.envrc
 __pycache__/
+outline
 output_*
-outline

README.md

@@ -1,29 +1,37 @@
 # mariadb_pdf
 
 ## Installation
+
 - install [python](https://www.python.org/downloads/) `(3.10+)`
 - install [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html) (if on windows copy wkhtmltopdf.exe to this directory)
-- Install python packages with (pip/pip3)
+- Install python packages with (pip/pip3):
     - toml
     - pdfkit
     - requests
     - bs4
 
+If you are on Linux (not tested on MacOS or Windows), you can setup a virtual
+environment with the following commands (needs `virtualenv`):
+
+```console
+virtualenv .venv
+source .venv/bin/activate
+pip3 install -r requirements.txt
+```
+
 ##  Usage
 
-- make sure
-[mariadb_kb_server](https://github.com/icerath/mariadb_kb_server)
+- make sure [mariadb_kb_server](https://github.com/icerath/mariadb_kb_server)
 is running.
 - run `'(python/python3) main.py'`
 
-
-
 ## Dependencies
-- python 3.10 +
-- wkhtmltopdf
+
+See [requirements.txt](./requirements.txt).
 
 ### Libraries
+
 - toml
 - pdfkit
 - requests
-- bs4
+- bs4

config.toml

@@ -1,6 +1,6 @@
-[TOC] 
-main_font_size = "12px"
-main_indent = "1em"
+[TOC]
+main_font_size = "13px"
+main_indent = "0.8em"
 main_margin = "0.5em"
 
 chapter_font_size = "18px"
@@ -23,4 +23,4 @@ dump-outline = "outline"
 encoding = "UTF-8"
 footer-line = ""
 quiet = ""
-disable-javascript = true
+disable-javascript = true

requirements.txt

@@ -0,0 +1,4 @@
+bs4
+pdfkit
+requests
+toml