From 31b8badb90490088b7dd5c087805dc4d72e4929f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Desmaretz?= Date: Tue, 8 Oct 2024 22:48:30 +0200 Subject: [PATCH] Add Readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9da7ded --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# README + +## Installation + +- **Archlinux**: `sudo pacman -Sy typst` +- **Debian**: + ``` + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + sudo apt install pkg-config libssl-dev + cargo install --locked typst-cli + ``` + +## Usage + +To compile, run `./render.sh` + +To modify the content, see `data/` directory. \ No newline at end of file