mirror of
https://github.com/go-sylixos/elvish.git
synced 2024-12-13 18:07:51 +08:00
54 lines
3.3 KiB
Markdown
54 lines
3.3 KiB
Markdown
# Elvish: Friendly Interactive Shell and Expressive Programming Language
|
|
|
|
[](https://travis-ci.org/elves/elvish)
|
|
[](https://ci.appveyor.com/project/xiaq/elvish) <!-- [](https://xiaq.visualstudio.com/elvish/_build)
|
|
[](https://codecov.io/gh/elves/elvish) -->
|
|
[](https://coveralls.io/github/elves/elvish)
|
|
[](https://goreportcard.com/report/github.com/elves/elvish)
|
|
[](https://godoc.elv.sh)
|
|
[](https://github.com/elves/elvish/blob/master/LICENSE)
|
|
[](https://twitter.com/RealElvishShell)
|
|
|
|
Elvish is a friendly interactive shell and an expressive programming language.
|
|
It runs on Linux, BSDs, macOS and Windows. Despite its pre-1.0 status, it is
|
|
already suitable for most daily interactive use.
|
|
|
|
Most of the resources for Elvish can be found on the [official website](https://elv.sh).
|
|
|
|
User groups (all connected thanks to [matterbridge](https://github.com/42wim/matterbridge/)):
|
|
[](https://gitter.im/elves/elvish)
|
|
[](https://telegram.me/elvish)
|
|
[](https://webchat.freenode.net/?channels=elvish)
|
|
|
|
## Building Elvish
|
|
|
|
To build Elvish, you need
|
|
|
|
* Linux, {Free,Net,Open}BSD, macOS, or Windows (Windows support is experimental).
|
|
|
|
* Go >= 1.10.
|
|
|
|
If you have not done so, first set up your environment by following [How To Write Go Code](http://golang.org/doc/code.html).
|
|
|
|
There are two ways to build Elvish. You can build it directly with `go get`:
|
|
|
|
```sh
|
|
go get github.com/elves/elvish
|
|
```
|
|
|
|
However, binaries built in this way lacks some build-time information; for instance, `elvish -version` will show `unknown`. To add such information, use `make`:
|
|
|
|
```sh
|
|
cd `go env GOPATH`/src/github.com/elves/elvish
|
|
make get
|
|
```
|
|
|
|
In either cases, the binary is placed in `$GOPATH/bin`. Consider adding it to your `$PATH` if you want to run the Elvish binary you just built by just typing `elvish`.
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for more notes for contributors.
|
|
You can also join one of the developer groups (also connected together by
|
|
matterbridge):
|
|
[](https://gitter.im/elves/elvish-dev)
|
|
[](https://telegram.me/elvish_dev)
|
|
[](https://webchat.freenode.net/?channels=elvish-dev)
|