Add information about build from source

mkdika · May 5, 2020 · 3e75a85 · 3e75a85
1 parent a47d2fc
commit 3e75a85
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -39,6 +39,28 @@ head -n10  0.00s user 0.00s system 0% cpu 24.141 total
 
 It is faster!
 
+## Installation
+
+### Linux
+
+_Coming soon.._
+
+### MacOS
+
+_Coming soon.._
+
+## Build from source
+
+Install [Crystal](https://crystal-lang.org/install/) language and its pre requirement.
+
+```bash
+git clone https://github.com/mkdika/lff-cr.git
+cd lff-cr/
+shards build --production --release
+```
+
+The built binary will be available as `./bin/lff`
+
 ## Contributing
 
 1. Fork it (<https://github.com/mkdika/lff-cr/fork>)

diff --git a/lff b/lff