Hilbish/README.md

37 lines
834 B
Markdown
Raw Normal View History

2021-03-19 14:26:58 +00:00
# Hilbish
2021-03-20 05:45:17 +00:00
🎀 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.
2021-03-21 22:19:26 +00:00
# Links
- **[Documentation](https://github.com/Hilbis/Hilbish/wiki)**
2021-03-20 05:45:17 +00:00
# Building
Prebuilt binaries are not yet provided, so to try it out you'll have to manually compile.
2021-03-20 05:45:17 +00:00
**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.
# Install
`sudo cp hilbish /usr/bin`
`sudo mkdir /usr/share/hilbish`
2021-03-21 21:46:13 +00:00
`sudo cp libs preload.lua .hilbishrc.lua /usr/share/hilbish -r`
2021-03-20 05:45:17 +00:00
# License
[MIT](LICENSE)