From 33d211a481eb0b8f8a8d4aad764c2b61c43f913f Mon Sep 17 00:00:00 2001 From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com> Date: Sat, 20 Mar 2021 01:45:17 -0400 Subject: [PATCH] chore: add a complete readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9fa4c99..a6eccf3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ # Hilbish -A shell for flower lovers +🎀 a nice lil shell for lua people made with go and lua + +# 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. + +**NOTE:** Hilbish is currently only officially supported and tested on Linux + +### Requirements +- Go 1.16 + +### Setup +``` +git clone https://github.com/Hilbis/Hilbish +cd Hilbish +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. + +# License +[MIT](LICENSE)