From d8aa83f00e33a57d34ce6d9ec76d16fd5a492e1b Mon Sep 17 00:00:00 2001 From: Florian Knoch Date: Sat, 14 Jul 2018 10:14:42 +0200 Subject: [PATCH] Add detailed installation instruction --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 67ed8f5..0ad52c1 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,27 @@ fooboar@forest:~$ ## 🌲 Usage +Download the newest [release](https://git.wiai.de/fknoch/oink/releases). Then run: + ```sh $ chmod +x "/path/to/oink.sh" -$ alias oink="/path/to/oink.sh" +``` + +Add the following lines at the end of your `~\.bashrc`. +```bash +# Fooboar +alias oink="/path/to/oink.sh" +``` + +To persist your changes, run: + +```bash +$ . ~/.bashrc +``` + +Now Fooboar can talk to you. + +```bash $ oink Heyho! ```