aboutsummaryrefslogtreecommitdiff
path: root/doc/getting-started/installation.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2024-01-25 18:08:18 +0100
committermetamuffin <metamuffin@disroot.org>2024-01-25 18:08:18 +0100
commitcd6b484d24b638f08221ff1388564d8369d37126 (patch)
treeb820445c91fb811e64cffcc9aaaa35eeac588cbd /doc/getting-started/installation.md
parent9d08704069f09f185eac0b80653cc39c1335c852 (diff)
downloadjellything-cd6b484d24b638f08221ff1388564d8369d37126.tar
jellything-cd6b484d24b638f08221ff1388564d8369d37126.tar.bz2
jellything-cd6b484d24b638f08221ff1388564d8369d37126.tar.zst
add some mdbook documentation
Diffstat (limited to 'doc/getting-started/installation.md')
-rw-r--r--doc/getting-started/installation.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/getting-started/installation.md b/doc/getting-started/installation.md
new file mode 100644
index 0000000..7496b16
--- /dev/null
+++ b/doc/getting-started/installation.md
@@ -0,0 +1,24 @@
+# Installation
+
+## From the AUR
+
+This is the recommended option. It will also install a systemd service running
+in its own user.
+
+```sh
+git clone https://aur.archlinux.org/jellything-git.git
+cd jellything-git
+makepkg -si
+```
+
+## From source
+
+```sh
+git clone --recursive https://codeberg.org/metamuffin/jellything.git
+cd jellything
+cargo build --release
+# Global installation
+cp target/release/{jellything,jellytool} /usr/local/bin
+# User installation
+cp target/release/{jellything,jellytool} ~/.local/bin
+``` \ No newline at end of file