docs: slight touch ups to readme

branding-cleanup
sammyette 2023-04-13 16:37:14 -04:00
parent 22fbe3bb1c
commit 73d23b387a
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
1 changed files with 19 additions and 20 deletions

View File

@ -1,23 +1,21 @@
<div align="center"> <img src="./assets/hilbish-flower.png" width=128>
<img src="./assets/hilbish-flower.png" width=128><br> <img src="./assets/hilbish-text.png" width=256><br>
<img src="./assets/hilbish-text.png" width=256><br> <blockquote>
<blockquote> 🌙 A Moon-powered shell!
🌺 The flower shell. A comfy and nice little shell for Lua fans! </blockquote>
</blockquote> <p align="center">
<p align="center">
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/Rosettea/Hilbish?style=flat-square"> <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/Rosettea/Hilbish?style=flat-square">
<img alt="GitHub commits since latest release (by date)" src="https://img.shields.io/github/commits-since/Rosettea/Hilbish/latest?style=flat-square"> <img alt="GitHub commits since latest release (by date)" src="https://img.shields.io/github/commits-since/Rosettea/Hilbish/latest?style=flat-square">
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/Rosettea/Hilbish?style=flat-square"><br> <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/Rosettea/Hilbish?style=flat-square"><br>
<a href="https://github.com/Rosettea/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22"><img src="https://img.shields.io/github/issues/Hilbis/Hilbish/help%20wanted?style=flat-square&color=green" alt="help wanted"></a> <a href="https://github.com/Rosettea/Hilbish/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22"><img src="https://img.shields.io/github/issues/Hilbis/Hilbish/help%20wanted?style=flat-square&color=green" alt="help wanted"></a>
<a href="https://github.com/Rosettea/Hilbish/blob/master/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/Rosettea/Hilbish?style=flat-square"></a> <a href="https://github.com/Rosettea/Hilbish/blob/master/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/Rosettea/Hilbish?style=flat-square"></a>
<a href="https://discord.gg/3PDdcQz"><img alt="Discord" src="https://img.shields.io/discord/732357621503229962?color=blue&style=flat-square"></a> <a href="https://discord.gg/3PDdcQz"><img alt="Discord" src="https://img.shields.io/discord/732357621503229962?color=blue&style=flat-square"></a>
</p> </p>
</div>
Hilbish is a extensible shell (framework). It was made to be very customizable Hilbish is an extensible shell designed to be highly customizable.
via the Lua programming language. It aims to be easy to use for the casual It is configured in Lua and provides a good range of features.
people but powerful for those who want to tinker more with their shell, It aims to be easy to use for anyone but powerful enough for
the thing used to interface with most of the system. those who need it.
The motivation for choosing Lua was that its simpler and better to use The motivation for choosing Lua was that its simpler and better to use
than old shell script. It's fine for basic interactive shell uses, than old shell script. It's fine for basic interactive shell uses,
@ -39,7 +37,8 @@ and aims to be infinitely configurable. If something isn't, open an issue!
# Getting Hilbish # Getting Hilbish
**NOTE:** Hilbish is not guaranteed to work properly on Windows, starting **NOTE:** Hilbish is not guaranteed to work properly on Windows, starting
from the 2.0 version. It will still be able to compile, but functionality from the 2.0 version. It will still be able to compile, but functionality
may be lacking. may be lacking. If you want to contribute to make the situation better,
comment on the Windows discussion.
You can check the [install page](https://rosettea.github.io/Hilbish/install/) You can check the [install page](https://rosettea.github.io/Hilbish/install/)
on the website for distributed binaries from GitHub or other package repositories. on the website for distributed binaries from GitHub or other package repositories.