summaryrefslogtreecommitdiff
path: root/SETUP.md
blob: c2fa7481df2d43187e401ba38f1e8b4ca7db02b8 (plain)

Setting up environment for building assets

These notes assume as baseline a Debian system. It is tested on Debian unstable and Debian testing, and should work also with Debian stable.

Core

The setup required for accessing and sharing changes to the project.

Debian

Install these official Debian packages:

sudo apt install git

Radicle

Download and install Radicle.

One alternative is to get the custom distributed draft deb-file and install it with sudo dpkg -i radicle_*.deb.

Alternatively manually install the contents of the tarball from their website.

When Radicle is installed (regardless of method), initialize your local identity:

rad auth

You might also want to familiarize yourself with radicle through the guide at their website.

When Radicle is installed, clone this project via the Radicle peer-to-peer network:

rad clone rad:z3aazGQX558YLccJ4qW2hYD1umiUy

If you need write access to this project, share your Radicle identity with existing project members. You can get your identity like this:

rad self --did

Existing project members (not you, yet) can then grant you access:

rad id update --delegate did:key:...

hedgedoc-cli

Clone the code project hedgedoc-cli:

mkdir --parents ~/Projects
cd ~/Projects
git clone https://github.com/hedgedoc/cli hedgedoc-cli

Add link in personal bin folder to cloned CLI script:

mkdir --parents ~/bin
cd ~/bin
ln --symbolic --target-directory=. ../Projects/hedgedoc-cli/bin/hedgedoc

Manuscript

The setup required for building the default make target.

Debian

Install these official Debian packages:

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

Quarto

Download and install newest stable version of Quarto from their website.

Miscellaneous

Optional setup - e.g. needed for secondary make targets.

Debian

Install these official Debian packages:

sudo apt install texlive-binaries-sse2
sudo apt install bat