mirror of https://github.com/Hilbis/Hilbish
Compare commits
No commits in common. "83a2ce38ea57da06ef731062804c67d5ef2c7a8a" and "6eea5bce47646f27eaed44aa147f53429c0a1fd7" have entirely different histories.
83a2ce38ea
...
6eea5bce47
21
README.md
21
README.md
|
@ -66,7 +66,6 @@ If you're new to nix you should probably read up on how to do that [here](https:
|
||||||
## Manual Build
|
## Manual Build
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- [Go 1.17+](https://go.dev)
|
- [Go 1.17+](https://go.dev)
|
||||||
- [Task](https://taskfile.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
|
||||||
|
@ -79,16 +78,30 @@ go get -d ./...
|
||||||
|
|
||||||
To build, run:
|
To build, run:
|
||||||
```
|
```
|
||||||
task
|
make dev
|
||||||
```
|
```
|
||||||
|
|
||||||
Or, if you want a stable branch, run these commands:
|
Or, if you want a stable branch, run these commands:
|
||||||
```
|
```
|
||||||
git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
|
git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
|
||||||
task build
|
make build
|
||||||
```
|
```
|
||||||
|
|
||||||
After you did all that, run `sudo task 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 Hilbish 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 are welcome! Hilbish is very easy to contribute to.
|
Any kind of contributions are welcome! Hilbish is very easy to contribute to.
|
||||||
|
|
Loading…
Reference in New Issue