sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

chore: add better install instructions and clarify some things

pull/5/head
TorchedSammy 2021-03-21 14:46:45 -04:00
parent adb3c0df16
commit aecf098d65
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,9 +1,14 @@
# Hilbish # Hilbish
🎀 a nice lil shell for lua people made with go and lua 🎀 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 # Building
Prebuilt binaries are not yet provided, since Hilbish is not stable. Prebuilt binaries are not yet provided, so to try it out you'll have to manually compile.
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 **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. 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 # License
[MIT](LICENSE) [MIT](LICENSE)