Installation¶
System Requirements¶
- Python 3.11+
Install dependencies¶
Common¶
uv¶
You might skip this step if you know what you are doing and prefer other methods of installation for Python packages (e.g.
pip).
For installation instructions visit: https://docs.astral.sh/uv/getting-started/installation/
Pandoc¶
Pandoc is used as a default command for transformation of markdown files to TeX.
For installation instructions visit: https://pandoc.org/installing.html
E.g.:
sudo apt install pandoc
sudo dnf install pandoc
winget install --source winget --exact --id JohnMacFarlane.Pandoc
For certain installations (e.g., using uv), it is recommended to install the pandocfilters package system-wide. This is because the Pandoc tool is executed in a new process, which will not have access to SeReTo dependencies.
pip install pandocfilters
Linux¶
First see Common section.
TeX Live¶
TeX Live is a distribution of the TeX/LaTeX typesetting system.
sudo apt install texlive-full
sudo dnf install texlive-scheme-full
Windows¶
First see Common section.
MikTeX¶
MikTeX is a distribution of the TeX/LaTeX typesetting system for Microsoft Windows.
For installation instructions visit: https://miktex.org/download
Perl¶
Perl is a programming language that is commonly used for text manipulation.
Install e.g. Strawberry Perl from: https://strawberryperl.com/
Install SeReTo¶
uv tool install sereto
uv tool install git+https://github.com/s3r3t0/sereto
Docker¶
Alternatively you can use SeReTo in a Docker container. You will need to mount the directories with projects and templates to the container.
docker run -it --rm -v "<path_to_projects>:/projects" -v "<path_to_templates>:/templates" sereto/sereto
docker build . -t sereto
docker run -it --rm -v "<path_to_projects>:/projects" -v "<path_to_templates>:/templates" sereto