summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRyan Geary <rtgnj42@gmail.com>2019-09-17 17:17:43 -0400
committerRyan Geary <rtgnj42@gmail.com>2019-09-17 22:06:04 -0400
commit6c889b3963c797da78918f35709c3a12d0931cb0 (patch)
tree4574ad2bab601ca62e86b3b5fdbc4f31e987f9d8
parentd226c750ef1babaff0e332f6c0c2fd9acbc2d9af (diff)
Add compilation instructions
-rw-r--r--readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 5be3c5a..e95d8ac 100644
--- a/readme.md
+++ b/readme.md
@@ -65,3 +65,19 @@ choose :3 # print the beginning of the line to the 3rd item,
choose 3: # print the third item to the end of the line
```
+
+## Compilation and Installation
+
+In order to build `choose` you will need rust installed, and you can find
+instructions for that [here](https://www.rust-lang.org/tools/install).
+
+Then, to install:
+
+```bash
+git clone https://github.com/theryangeary/choose.git
+cd choose
+cargo build --release
+install target/release/choose <DESTDIR>
+```
+
+Just make sure DESTDIR is in your path.