diff --git a/README.md b/README.md index d50ac96..bfc1b96 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,23 @@
-

Hilbish

+
+ +

- 🎀 a nice lil shell for lua people made with go and lua -

- help wanted - + 🌺 The flower shell. A comfy and nice little shell for Lua users and fans! + +

+ GitHub commit activity + GitHub commits since latest release (by date) + GitHub contributors
+ help wanted + GitHub license + Discord

-Hilbish is an interactive Unix-like shell written in Go, with the config -and other code written in Lua. -It is sort of in a stable state currently, usable as a daily shell, -but there may still be breaking changes in Lua modules. +Hilbish is a new, Unix-like shell which uses Lua as its configuration language. +It's decently fast for interactive use and includes a bunch of utility functions and features +to make your life in a terminal easier. # Screenshots
@@ -42,21 +48,22 @@ like what is highlighted in the screenshot.

### AUR -Arch Linux users can install Hilbish from the AUR. +![AUR maintainer](https://img.shields.io/aur/maintainer/hilbish?logo=arch-linux&style=flat-square) +Arch Linux users can install Hilbish from the AUR with the following command: ```sh yay -S hilbish ``` -If you want the latest and greatest, you can install and compile from the latest git commit +Or from the latest `master` commit with: ```sh yay -S hilbish-git ``` ### Manual Build #### Prerequisites -- [Go 1.16](https://go.dev) +- [Go 1.16+](https://go.dev) - GNU Readline -On Fedora, readline can be installed with: +On Fedora or other RPM based distros, readline can be installed with: ``` sudo dnf install readline-devel ``` @@ -66,11 +73,6 @@ On Debian/Ubuntu and distros based on them, it can be installed with: sudo apt install libreadline-dev ``` -On OpenSUSE, it can be installed with: -``` -sudo zypper install readline-devel -``` - On Arch Linux, it can be installed with: ``` sudo pacman -S readline @@ -79,48 +81,38 @@ sudo pacman -S readline #### Build First, clone Hilbish: ```sh -git clone --recursive https://github.com/Hilbis/Hilbish +git clone --recursive https://github.com/Rosettea/Hilbish cd Hilbish -# If you want the latest stable release, run this following command -git checkout $(git describe --tags `git rev-list --tags --max-count=1`) -``` +go get -d ./... +``` -And get dependencies and build: -```sh -go get -d all +To build, run: +``` make dev +``` + +Or, if you want a stable branch, run these commands: ``` +git checkout $(git describe --tags `git rev-list --tags --max-count=1`) +make build +``` -If you `git checkout`'d the latest stable release, run -`make build` instead of `make dev`. -or want to experiment Hilbiline, instead run -`make hilbiline` - -#### Install -`sudo make install` - -### Uninstall -```sh -sudo make uninstall -``` +After you did all that, run `sudo make install` to install Hilbish globally. # 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: +Any kind of contributions to Hilbish are welcome! +Read [CONTRIBUTING.md](CONTRIBUTING.md) before getting started. +##### Thanks to everyone below who's contributed! *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 -Hilbish is licensed under the MIT license. -[Read here](LICENSE) for more info. +Hilbish is licensed under the MIT license! +Read the [license here](LICENSE) for more info. + +Images in the [assets](assets/) folder are under CC-BY-SA 4.0 + diff --git a/assets/hilbish-flower.png b/assets/hilbish-flower.png new file mode 100644 index 0000000..b4fb0f7 Binary files /dev/null and b/assets/hilbish-flower.png differ diff --git a/assets/hilbish-text.png b/assets/hilbish-text.png new file mode 100644 index 0000000..16412c4 Binary files /dev/null and b/assets/hilbish-text.png differ diff --git a/gallery/default.png b/gallery/default.png index 8179498..d2cb2c6 100644 Binary files a/gallery/default.png and b/gallery/default.png differ diff --git a/gallery/terminal.png b/gallery/terminal.png index 314adfb..21043cf 100644 Binary files a/gallery/terminal.png and b/gallery/terminal.png differ