diff options
| -rw-r--r-- | SETUP.md | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/SETUP.md b/SETUP.md new file mode 100644 index 0000000..4e1ed3d --- /dev/null +++ b/SETUP.md @@ -0,0 +1,97 @@ +# Setting up environment for building assets + +These notes assume as baseline a Debian trixie system +(i.e. Debian testing as of February 2025). + +## 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. + +Simplest is to get a preliminary build +of the upcoming [Debian package] +and install it with `sudo dpkg -i radicle_*.deb`. +Alternatively build and install from [upstream source]. + +[Debian package]: <https://bugs.debian.org/1073266> + +[upstream source]: <https://radicle.xyz/download> + +When Radicle is installed (regardless of method), +initialize once your local system-wide identity: + +``` +rad auth +``` + +You might also want to familiarize yourself with radicle +through the guide at [the upstream website][Radicle User Guide]. + +[Radicle User Guide]: <https://radicle.xyz/guides/user> + +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:... +``` + +## 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][Quarto landing page]. + +[Quarto landing page]: <https://quarto.org/docs/get-started/> + +## 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 +``` |