chore: merge from master

pull/59/head
sammyette 2021-05-21 21:11:41 -04:00
commit a88850357e
No known key found for this signature in database
GPG Key ID: 50EE40A2809851F5
2 changed files with 57 additions and 16 deletions

31
.github/workflows/build.yml vendored 100644
View File

@ -0,0 +1,31 @@
name: Build
on:
- push
- pull_request
jobs:
build:
name: ${{ matrix.build }}
runs-on: ${{ matrix.os }}
strategy:
matrix:
include:
- build: linux-amd64
os: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Setup Go
uses: actions/setup-go@v2
with:
go-version: '1.16.2'
- name: Build
run: make hilbiline
- uses: actions/upload-artifact@v2
with:
name: hilbish-${{ matrix.build }}
path: hilbish

View File

@ -25,16 +25,27 @@ but there may still be breaking changes in Lua modules.
- **[Gallery](https://github.com/Hilbis/Hilbish/discussions/36)** - See
more screenshots of Hilbish in action
# Building
Prebuilt binaries are not yet provided, so to try it out you'll have to manually compile.
# Installation
**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)
- GNU Readline
On Fedora, readline can be installed with:
```
sudo dnf install readline-devel
@ -50,27 +61,26 @@ On OpenSUSE, it can be installed with:
sudo zypper install readline-devel
```
### Install
#### Build
First, clone Hilbish:
```sh
git clone --recursive https://github.com/Hilbis/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`)
```
Then build and install:
And get dependencies and build:
```sh
go get -d
make dev
sudo make install
# Or
sudo make all
```
Or, if you want the latest stable release:
```
git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
# If you want to use latest stable release,
make build
sudo make install
# or want to use Hilbiline,
make hilbiline
```
#### Install
`sudo make install`
Alternatively, if you use Arch Linux, you can compile Hilbish with an **(unofficial)** AUR package:
```sh