doc: added install from release instructions

xNaCly · Mar 30, 2023 · 1cb51f9 · 1cb51f9
1 parent f9e1204
commit 1cb51f9
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ dist/
 *.tape
 *.mp4
 *.gif
+*.log
diff --git a/README.md b/README.md
@@ -6,6 +6,18 @@ https://user-images.githubusercontent.com/47723417/228802151-056a549a-5bbf-43af-
 
 ## Install
 
+### From release
+
+1. Download the [latest release](https://github.com/xNaCly/gleichzeitig/releases/latest) for your architecture.
+2. Extract the archive
+3. Move the binary to an executable path:
+   - Linux:
+     ```console
+     $ sudo mv ./gleichzeitig /usr/bin/gleichzeitig
+     ```
+   - Windows:
+     > copy `gleichzeitig` to `C:\Program Files`
+
 ### From source
 
 > requires git and go
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,3 +2,4 @@ dist/ @@
     *.tape
     *.mp4
     *.gif
+    *.log