elvish/README.md
Qi Xiao f03b3adb69
Update README.md
Show group badges on the same line.
2018-11-05 00:46:23 +00:00

3.3 KiB

Elvish: Friendly Interactive Shell and Expressive Programming Language

Build Status on Travis Build status on AppVeyor Code Coverage on coveralls.io Go Report Card GoDoc License Twitter

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.

User groups (all connected thanks to matterbridge): Gitter Telegram Group #elvish on freenode

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.

There are two ways to build Elvish. You can build it directly with go get:

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:

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 for more notes for contributors. You can also join one of the developer groups (also connected together by matterbridge): Gitter for Developers Telegram Group for Developers #elvish-dev on freenode