docs: update readme with new description

windows-fixes
TorchedSammy 2021-12-14 10:19:11 -04:00
parent fe8372379c
commit afa40dd1a1
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
1 changed files with 10 additions and 10 deletions

View File

@ -1,6 +1,6 @@
<div align="center"> <div align="center">
<img src="./assets/hilbish-flower.png" width=128><br> <img src="./assets/hilbish-flower.png" width=128><br>
<img src="./assets/hilbish-text.png" width=256><br><br> <img src="./assets/hilbish-text.png" width=256><br>
<blockquote> <blockquote>
🌺 The flower shell. A comfy and nice little shell for Lua users and fans! 🌺 The flower shell. A comfy and nice little shell for Lua users and fans!
</blockquote><br> </blockquote><br>
@ -14,9 +14,12 @@
</p> </p>
</div> </div>
Hilbish is a new, Unix-like shell which uses Lua as its configuration language. Hilbish is a Unix-y shell which uses Lua for scripting. Things like the prompt,
It's decently fast for interactive use and includes a bunch of utility functions and features general configuration and such are done with Lua.
to make your life in a terminal easier.
For interactive use, it uses a library to run sh which works on all
platforms Hilbish can be compiled for. It can also act as a Lua REPL if you want
it to be.
# Screenshots # Screenshots
<div align="center"> <div align="center">
@ -102,7 +105,7 @@ After you did all that, run `sudo make install` to install Hilbish globally.
Any kind of contributions to Hilbish are welcome! Any kind of contributions to Hilbish are welcome!
Read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started. Read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started.
##### Thanks to everyone below who's contributed! **Thanks to everyone below who's contributed!**
<a href="https://github.com/Hilbis/Hilbish/graphs/contributors"> <a href="https://github.com/Hilbis/Hilbish/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Hilbis/Hilbish" /> <img src="https://contrib.rocks/image?repo=Hilbis/Hilbish" />
</a> </a>
@ -110,8 +113,5 @@ Read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started.
*Made with [contributors-img](https://contrib.rocks).* *Made with [contributors-img](https://contrib.rocks).*
# License # License
Hilbish is licensed under the MIT license! Hilbish is licensed under the [MIT license](LICENSE).
Read the [license here](LICENSE) for more info. [Images and assets](assets/) are licensed under CC-BY-SA 4.0
Images in the [assets](assets/) folder are under CC-BY-SA 4.0