docs: add more info to readme

pull/128/head
TorchedSammy 2022-03-22 21:59:34 -04:00
parent 23efc8e54d
commit a7e450904c
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
1 changed files with 40 additions and 13 deletions

View File

@ -1,9 +1,9 @@
<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> <img src="./assets/hilbish-text.png" width=256><br>
<blockquote> <i>
🌺 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 fans!
</blockquote> </i>
<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">
@ -14,12 +14,25 @@
</p> </p>
</div> </div>
Hilbish is a Unix-y shell which uses Lua for scripting. Things like the prompt, Hilbish is a extensible shell (framework). It was made to be very customizable
general configuration and such are done with Lua. via the Lua programming language. It aims to be easy to use for the casual
people but powerful for those who want to tinker more with their shell,
the thing used to interface with most of the system.
For interactive use, it uses a library to run sh which works on all The motivation for choosing Lua was that its simpler and better to use
platforms Hilbish can be compiled for. It can also act as a Lua REPL if you want than old shell script. It's fine for basic interactive shell uses,
it to be. but that's the only place Hilbish has shell script; everything else is Lua
and aims to be infinitely configurable. If something isn't, open an issue!
# Table of Contents
- [Screenshots](#Screenshots)
- [Installation](#Installation)
- [Prebuilt Bins](#Prebuilt-binaries)
- [AUR](#AUR)
- [Nixpkgs](#Nixpkgs)
- [Manual Build](#Manual-Build)
- [Getting Started](#Getting-Started)
- [Contributing](#Contributing)
# Screenshots # Screenshots
<div align="center"> <div align="center">
@ -54,7 +67,7 @@ If you're new to nix you should probably read up on how to do that [here](https:
### Prerequisites ### Prerequisites
- [Go 1.17+](https://go.dev) - [Go 1.17+](https://go.dev)
#### Build ### Build
First, clone Hilbish. The recursive is required, as some Lua libraries First, clone Hilbish. The recursive is required, as some Lua libraries
are submodules. are submodules.
```sh ```sh
@ -76,13 +89,27 @@ make build
After you did all that, run `sudo make install` to install Hilbish globally. After you did all that, run `sudo make install` to install Hilbish globally.
# Getting Started
At startup, you should see a message which says to run a `guide` command.
This guide is a *very* simple and basic step through text of what Hilish is
and where to find documentation.
Documentation is primarily viewed via the in shell `doc` command.
Autogenerated function docs and general docs about other things are included
there, so be sure to read it.
Using Hilbish is the same as using any other Linux shell, with an addition
that you can also run Lua. Hilbish can also act as an enhanced Lua REPL
via `hilbish.runnerMode 'lua'`. To switch back to normal, use
`hilbish.runnerMode 'hybrid'`.
# Contributing # Contributing
Any kind of contributions to Hilbish are welcome! Any kind of contributions are welcome! Hilbish is very easy to contribute to.
Read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started. Read [CONTRIBUTING.md](CONTRIBUTING.md) as a guideline to doing so.
**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/Rosettea/Hilbish/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Hilbis/Hilbish" /> <img src="https://contrib.rocks/image?repo=Rosettea/Hilbish" />
</a> </a>
*Made with [contributors-img](https://contrib.rocks).* *Made with [contributors-img](https://contrib.rocks).*