summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Paul <n@nc0.fr>2023-10-03 17:08:48 +0200
committerNicolas Paul <n@nc0.fr>2023-10-03 17:08:48 +0200
commit2d5d4c7ab9e08b896957743df684fa387d476726 (patch)
tree995856b7dac2e866299468e84263599a48be92af
parent94c5079e52e3dd5fafcde4586a30a7dd4c002cd9 (diff)
Add installation instructions to README
-rw-r--r--README20
1 files changed, 19 insertions, 1 deletions
diff --git a/README b/README
index 7358a43..6b9d2f8 100644
--- a/README
+++ b/README
@@ -12,7 +12,25 @@ my own domain (go.nc0.fr) and imported via go.nc0.fr/foo.
Getting started
---------------
-TODO
+You can install SVGU via Homebrew, using the Go toolchain, or compiling from
+sources.
+
+Homebrew:
+
+ $ brew install nc0fr/nc0/svgu
+
+Go:
+
+ $ go install go.nc0.fr/svgu@latest
+
+Compiling from sources (requires Go, Git and Make):
+
+ $ git clone https://github.com/nc0fr/svgu.git
+ $ cd svgu
+ $ make
+
+Please refer to the online documentation (https://svgu.nc0.fr) for more
+information.
License
-------