summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Paul <n@nc0.fr>2023-10-03 09:53:49 +0200
committerNicolas Paul <n@nc0.fr>2023-10-03 16:00:05 +0200
commit7bc76f54ff0bafcf23fb021a2e7f34d1860ca449 (patch)
treeba22174cb224fb10114805089544e59c5b966800
parentc7313a361d69efc4853c17c18d1591cd5f891648 (diff)
Document installation processes
-rw-r--r--doc/pages/index.mdx42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/pages/index.mdx b/doc/pages/index.mdx
index cd0938c..730ad9b 100644
--- a/doc/pages/index.mdx
+++ b/doc/pages/index.mdx
@@ -76,6 +76,48 @@ call this behavior "Pretty URLs").
## Installation
+If you do not see your operating system, use the [Go](#go) or
+[compiling from source](#from-source) methods. Consider contributing to add
+your own operating system installation!
+
+### Homebrew
+
+Nicolas Paul maintain an external [Homebrew](https://brew.sh) repository
+which allows installing SVGU on macOS and some GNU/Linux systems.
+
+```bash
+$ brew install nc0fr/nc0/svgu
+```
+
+### Go
+
+The standard Go toolchain allows installing binaries directly. You only
+require [Go 1.16+](https://go.dev).
+
+```bash
+$ # You can replace latest with any Git ref needed.
+$ go install go.nc0.fr/svgu@latest
+```
+
+### From Source
+
+Compiling SVGU from source requires [Git](https://git-scm.com) and
+[Go](https://go.dev) (1.16 or more).
+
+First, clone the repository from our GitHub origin:
+
+```bash
+$ git clone https://github.com/nc0fr/svgu.git
+$ cd svgu
+```
+
+Then, you can simply build the Go software using `make`:
+
+```bash
+$ make
+$ ./svgu -h
+```
+
## Licensing
SVGU is a free software, available under the