summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKyren223 <Kyren223@proton.me>2025-07-21 16:28:28 +0300
committerKyren223 <Kyren223@proton.me>2025-07-21 16:28:28 +0300
commit6ed8ee90c2dfc4fb1bc7fa8cc038fa7352821166 (patch)
tree485bc71214b1ba7e75fb9a2170d71a01751a8fcd /README.md
parent15cc3912218e04004a172060009c735a2a17187c (diff)
Added build from source instructions in readme (incomplete?)
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5d46eaf..1173e40 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,20 @@ The Discord alternative for Terminal nerds.
### From source
+Clone the repository
+
+```
+git clone https://github.com/kyren223/eko
+```
+
+Build the executable (make sure you have `go` installed)
+
+```
+cd eko && go build -o ./eko ./cmd/client
+```
+
+Move the executable to somewhere in your path so you can access it from anywhere
+
## Usage
Once installed, run `eko` in a terminal.