sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

docs: clean up install section on readme

readline-upstream
sammyette 2022-12-28 20:18:30 -04:00
parent 68a37d8c79
commit c12cb82fb5
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
1 changed files with 7 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -26,11 +26,7 @@ and aims to be infinitely configurable. If something isn't, open an issue!
# Table of Contents # Table of Contents
- [Screenshots](#Screenshots) - [Screenshots](#Screenshots)
- [Installation](#Installation) - [Getting Hilbish](#Getting-Hilbish)
- [Prebuilt Bins](#Prebuilt-binaries)
- [AUR](#AUR)
- [Nixpkgs](#Nixpkgs)
- [Manual Build](#Manual-Build)
- [Contributing](#Contributing) - [Contributing](#Contributing)
# Screenshots # Screenshots
@ -40,38 +36,20 @@ and aims to be infinitely configurable. If something isn't, open an issue!
<img src="gallery/pillprompt.png"> <img src="gallery/pillprompt.png">
</div> </div>
# Installation # 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.
## Prebuilt binaries You can check the [install page](https://rosettea.github.io/Hilbish/install/)
Go [here](https://nightly.link/Rosettea/Hilbish/workflows/build/master) for on the website for distributed binaries from GitHub or other package repositories.
builds on the master branch. Otherwise, continue reading for steps on compiling.
## AUR ## Prerequisites
[![AUR maintainer](https://img.shields.io/aur/maintainer/hilbish?logo=arch-linux&style=flat-square)](https://aur.archlinux.org/packages/hilbish)
Arch Linux users can install Hilbish from the AUR with the following command:
```sh
yay -S hilbish
```
[![AUR maintainer](https://img.shields.io/aur/maintainer/hilbish?logo=arch-linux&style=flat-square)](https://aur.archlinux.org/packages/hilbish-git)
Or from the latest `master` commit with:
```sh
yay -S hilbish-git
```
## Nixpkgs
Nix/NixOS users can install Hilbish from the central repository, nixpkgs, through the usual ways.
If you're new to nix you should probably read up on how to do that [here](https://nixos.wiki/wiki/Cheatsheet).
## Manual Build
### Prerequisites
- [Go 1.17+](https://go.dev) - [Go 1.17+](https://go.dev)
- [Task](https://taskfile.dev/installation/) (**Go on the hyperlink here to see Task's install method for your OS.**) - [Task](https://taskfile.dev/installation/) (**Go on the hyperlink here to see Task's install method for your OS.**)
### 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