Skip to content

Commit

Permalink
Improve documentation for Linux installation
Browse files Browse the repository at this point in the history
For installation, it's recommended to use python virtualenvironments on
Linux.
The size of the font for the TOC needed increase to fix a bad alignment
that seems to happen only on Linux.
  • Loading branch information
fauust committed Jun 1, 2023
1 parent 9f2684f commit f225098
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 11 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
*.exe
*.py[cod]
.envrc
__pycache__/
outline
output_*
outline
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[TOC]
main_font_size = "12px"
main_font_size = "13px"
main_indent = "1em"
main_margin = "0.5em"

Expand All @@ -23,4 +23,4 @@ dump-outline = "outline"
encoding = "UTF-8"
footer-line = ""
quiet = ""
disable-javascript = true
disable-javascript = true
4 changes: 4 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
bs4
pdfkit
requests
toml

0 comments on commit f225098

Please sign in to comment.