Hilbish/README.md

52 lines
1002 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).
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
2021-04-04 17:15:55 +00:00
### Prerequisites
- [Go 1.16](https://go.dev)
- GNU Readline
On Fedora, readline can be installed with:
```
sudo dnf install readline-devel
```
On Debian/Ubuntu and distros based on them, it can be installed with:
```
sudo apt install libreadline-dev
```
2021-03-20 05:45:17 +00:00
### Install
```sh
2021-03-20 05:45:17 +00:00
git clone https://github.com/Hilbis/Hilbish
cd Hilbish
make build
sudo make install
# Or
sudo make all
2021-03-20 05:45:17 +00:00
```
Alternativly, if you use Arch Linux, you can install Hilbish with an **(unofficial)** AUR package
```sh
yay -S hilbish-git
```
### Uninstall
```sh
sudo make uninstall
```
2021-03-20 05:45:17 +00:00
# License
[MIT](LICENSE)