diff options
Diffstat (limited to 'SETUP.md')
| -rw-r--r-- | SETUP.md | 38 |
1 files changed, 26 insertions, 12 deletions
@@ -1,15 +1,27 @@ -# Setting up environment for building thoughtroam assets +# Setting up environment for building assets ## System requirements ### Debian -Install required packages: +Install packages required for the default make target: ``` -sudo apt install texlive-luatex texlive-binaries-sse2 texlive-lang-european texlive-latex-extra texlive-fonts-extra -sudo apt install git make citation-style-language-styles plantuml inkscape latexdiff +sudo apt install make texlive-luatex texlive-latex-extra texlive-fonts-extra +sudo apt install texlive-lang-european +sudo apt install citation-style-language-styles +sudo apt install pandoc-filter-diagram plantuml inkscape +``` + +Optionally install additional packages +e.g. for secondary make targets: + +``` +sudo apt install git texlive-binaries-sse2 +sudo apt install git man-db +sudo apt install bibclean libpath-tiny-perl libipc-run3-perl sudo apt install python-rdflib-tools xdot +sudo apt install latexdiff ``` ### Quarto @@ -19,7 +31,7 @@ from [their website](https://quarto.org/docs/get-started/). ### hedgedoc-cli -Clone code project hedgedoc-cli: +Clone the code project hedgedoc-cli: ``` mkdir --parents ~/Projects @@ -27,7 +39,7 @@ cd ~/Projects git clone https://github.com/hedgedoc/cli hedgedoc-cli ``` -Link to cloned CLI script from personal bin folder: +Add link in personal bin folder to cloned CLI script: ``` mkdir --parents ~/bin @@ -37,7 +49,7 @@ ln --symbolic --target-directory=. ../Projects/hedgedoc-cli/bin/hedgedoc ### Fonts -Install fonts included with project. +Install fonts included with project to personal font directory: ``` mkdir --parents ~/.fonts @@ -46,23 +58,25 @@ cp --target-directory ~/.fonts fonts/*/opentype/* ### PlantUML -Debian-packaged PlantUML is broken -(or just severely outdated, not sure), -so the core java file needs to be replaced with a newer working one. +Debian-packaged PlantUML is [too old](https://bugs.debian.org/1004135), +so the main jar file needs to be replaced with a newer working one. -Download newest version of PlantUML +Download newest GPL version of PlantUML from [their website](https://plantuml.com/download). Replace Debian-packaged plantuml with the downloaded file: ``` sudo mv /usr/share/plantuml/plantuml.jar /usr/share/plantuml/plantuml.jar.orig -sudo cp ~/Downloads/plantuml-1.2024.3.jar /usr/share/plantuml/plantuml.jar +sudo cp -T ~/Downloads/plantuml-*.jar /usr/share/plantuml/plantuml.jar sudo chown root: /usr/share/plantuml/plantuml.jar ``` ### JabRef +Debian-packaged JabRef is [too old](https://bugs.debian.org/877718), +so upstream-provided package is used instead. + Download and install newest stable version of JabRef from [their website](https://jabref.org/#download). |