latex/onpoint
6
0
Fork 0
Code Issues 2 Pull Requests Releases 1 Wiki Activity

Add troubleshooting section

Browse Source
This commit is contained in:
Florian 2025-04-30 18:54:59 +02:00
parent 10848c12d3
commit 898a2064d9
1 changed files with 32 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -4,15 +4,19 @@
This program is meant to be used as a git submodule of your actual presentation project, therefore you need to add it:
$ git submodule add -b release git@path-to-onpoint.git
```sh
git submodule add -b release git@path-to-onpoint.git
````
Make sure to have python3 and pandoc (the same version for all developers!) installed.
Next, we can install all requirements:
$ python3 -m venv venv
$ source venv/bin/activate
$ cd onpoint
$ pip3 install -r requirements.txt
```sh
python3 -m venv venv
source venv/bin/activate
cd onpoint
pip3 install -r requirements.txt
```
## The Project Structure
@ -57,4 +61,26 @@ In order to update the version of onPoint in an existing project, simply enter t
You might want to have all slides auto-compiled for you on safe. For this case, we wrote a small bash script that spawns a file watcher to compile your presentation once any markdown file in the slides folder is saved. Simply run `./onpoint/autocompile.sh` from your project root folder.
You will need Python and `inotify-tools` to execute the script.
You will need Python and `inotify-tools` to execute the script.
## Troubleshooting
### `libxml2` and/or `libxslt` development packages missing
Error message:
Collecting lxml==5.2.0 (from -r requirements.txt (line 2))
Using cached lxml-5.2.0.tar.gz (3.7 MB)
Installing build dependencies ... done
Getting requirements to build wheel ... error
error: subprocess-exited-with-error
× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> [4 lines of output]
<string>:67: DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html
Building lxml version 5.2.0.
Building without Cython.
Error: Please make sure the libxml2 and libxslt development packages are installed.
Make sure to install these two packages (`libxml2-dev`, `libxslt-dev` and `python-dev` on Ubuntu, `libxml2-devel`, `libxslt-devel` and `python-devel` on Fedora).