mirror of https://github.com/Hilbis/Hilbish
docs: add that precompiled binaries are provided, more details in install
parent
1f3162fc4f
commit
459606618c
33
README.md
33
README.md
|
@ -25,16 +25,27 @@ but there may still be breaking changes in Lua modules.
|
||||||
- **[Gallery](https://github.com/Hilbis/Hilbish/discussions/36)** - See
|
- **[Gallery](https://github.com/Hilbis/Hilbish/discussions/36)** - See
|
||||||
more screenshots of Hilbish in action
|
more screenshots of Hilbish in action
|
||||||
|
|
||||||
# Building
|
# Installation
|
||||||
Prebuilt binaries are not yet provided, so to try it out you'll have to manually compile.
|
|
||||||
|
|
||||||
**NOTE:** Hilbish is currently only officially supported and tested on Linux
|
**NOTE:** Hilbish is currently only officially supported and tested on Linux
|
||||||
|
|
||||||
### Prerequisites
|
### Prebuilt binaries
|
||||||
|
Binaries are provided for the latest commit.
|
||||||
|
|
||||||
|
**Note that these use Hilbiline, not readline, and may be missing functionality
|
||||||
|
(moving the cursor, proper unicode support and backspace working properly)**
|
||||||
|
|
||||||
|
Click on the checkmark (or x) near the commit hash, then details for your platform
|
||||||
|
<br><img src="https://modeus.is-inside.me/dyr8UGGq.png"><br>
|
||||||
|
|
||||||
|
Then click on the artifacts drop down, and download artifact for your platform,
|
||||||
|
like what is highlighted in the screenshot.
|
||||||
|
<br><img src="https://modeus.is-inside.me/KJ0Puceb.png"><br>
|
||||||
|
|
||||||
|
### Manual Build
|
||||||
|
#### Prerequisites
|
||||||
- [Go 1.16](https://go.dev)
|
- [Go 1.16](https://go.dev)
|
||||||
|
|
||||||
- GNU Readline
|
- GNU Readline
|
||||||
|
|
||||||
On Fedora, readline can be installed with:
|
On Fedora, readline can be installed with:
|
||||||
```
|
```
|
||||||
sudo dnf install readline-devel
|
sudo dnf install readline-devel
|
||||||
|
@ -50,14 +61,19 @@ On OpenSUSE, it can be installed with:
|
||||||
sudo zypper install readline-devel
|
sudo zypper install readline-devel
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install
|
#### Install
|
||||||
First, clone Hilbish:
|
First, clone Hilbish:
|
||||||
```sh
|
```sh
|
||||||
git clone --recursive https://github.com/Hilbis/Hilbish
|
git clone --recursive https://github.com/Hilbis/Hilbish
|
||||||
cd Hilbish
|
cd Hilbish
|
||||||
```
|
```
|
||||||
|
|
||||||
Then build and install:
|
And get dependencies:
|
||||||
|
```sh
|
||||||
|
go get -d
|
||||||
|
```
|
||||||
|
|
||||||
|
then, build and install:
|
||||||
```sh
|
```sh
|
||||||
make dev
|
make dev
|
||||||
sudo make install
|
sudo make install
|
||||||
|
@ -72,6 +88,9 @@ make build
|
||||||
sudo make install
|
sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you want to use Hilbiline instead, replace `make dev`/`make build` with `make hilbiline`.
|
||||||
|
`make build all` will still try to use readline.
|
||||||
|
|
||||||
Alternatively, if you use Arch Linux, you can compile Hilbish with an **(unofficial)** AUR package:
|
Alternatively, if you use Arch Linux, you can compile Hilbish with an **(unofficial)** AUR package:
|
||||||
```sh
|
```sh
|
||||||
yay -S hilbish
|
yay -S hilbish
|
||||||
|
|
Loading…
Reference in New Issue