docs: add screenshots and link to CONTRIBUTING.md

pull/38/head
TorchedSammy 2021-04-08 14:48:42 -04:00
parent e5d8f88f46
commit 74a6eda0f3
1 changed files with 37 additions and 5 deletions

View File

@ -1,11 +1,26 @@
# Hilbish <div align="center">
<h1>Hilbish</h1>
<blockquote>
🎀 a nice lil shell for lua people made with go and lua 🎀 a nice lil shell for lua people made with go and lua
</blockquote>
</div>
It is currently in a mostly beta state but is very much usable Hilbish is an interactive Unix-like shell written in Go, with the config
(I'm using it right now). and other code written in Lua.
It is currently in a Beta state. Though very fit for daily usage,
updates may contain breaking changes.
# Screenshots
<div align="center">
<img src="gallery/default.png"><br><br>
<img src="gallery/terminal.png"><br><br>
<img src="gallery/pillprompt.png">
</div>
# Links # Links
- **[Documentation](https://github.com/Hilbis/Hilbish/wiki)** - **[Documentation](https://github.com/Hilbis/Hilbish/wiki)**
- **[Gallery](https://github.com/Hilbis/Hilbish/discussions/36)** - See
more screenshots of Hilbish in action
# Building # Building
Prebuilt binaries are not yet provided, 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.
@ -51,5 +66,22 @@ yay -S hilbish
sudo make uninstall sudo make uninstall
``` ```
# Contributing
Any kind of contributions to Hilbish are welcome!
Make sure to read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started.
### Special Thanks To
Everyone here who has contributed:
<a href="https://github.com/Hilbis/Hilbish/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Hilbis/Hilbish" />
</a>
*Made with [contributors-img](https://contrib.rocks).*
### Credits
- [This blog post](https://www.vidarholen.net/contents/blog/?p=878) which
is how Hilbish now inserts a newline even if output doesn't have one.
# License # License
[MIT](LICENSE) Hilbish is licensed under the MIT license.
[Read here](LICENSE) for more info.