From aecf098d65165e0aa8212b0af5b87e23a594882a Mon Sep 17 00:00:00 2001 From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com> Date: Sun, 21 Mar 2021 14:46:45 -0400 Subject: [PATCH] chore: add better install instructions and clarify some things --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a6eccf3..e459c4c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ # Hilbish 🎀 a nice lil shell for lua people made with go and lua +It is currently in a mostly beta state but is very much usable +(I'm using it right now). + +There are still some things missing like pipes but granted that will be +added soon. + # Building -Prebuilt binaries are not yet provided, since Hilbish is not stable. -It is usable though, so to try it out you'll have to manually compile. +Prebuilt binaries are not yet provided, so to try it out you'll have to manually compile. **NOTE:** Hilbish is currently only officially supported and tested on Linux @@ -18,7 +23,11 @@ go build ``` This will build a `hilbish` executable in the current directory. -At which you can either run or move to a bin directory for easy use. + +# Install +`sudo cp hilbish /usr/bin` +`sudo mkdir /usr/share/hilbish` +`sudo cp libs preload.lua .hilbishrc.lua /usr/share/hilbish` # License [MIT](LICENSE)