github.com/elves/elvish@v0.15.0/README.md (about)

     1  # Elvish: Friendly Interactive Shell and Expressive Programming Language
     2  
     3  [![Test Status on Linux](https://img.shields.io/cirrus/github/elves/elvish?logo=Cirrus%20CI&label=linux&task=Test%20on%20Linux)](https://cirrus-ci.com/github/elves/elvish/master)
     4  [![Test Status on macOS](https://img.shields.io/cirrus/github/elves/elvish?logo=Cirrus%20CI&label=macos&task=Test%20on%20macOS)](https://cirrus-ci.com/github/elves/elvish/master)
     5  [![Test Status on FreeBSD](https://img.shields.io/cirrus/github/elves/elvish?logo=Cirrus%20CI&label=freebsd&task=Test%20on%20FreeBSD)](https://cirrus-ci.com/github/elves/elvish/master)
     6  [![Test status on Windows](https://img.shields.io/appveyor/ci/xiaq/elvish.svg?logo=AppVeyor&label=windows)](https://ci.appveyor.com/project/xiaq/elvish)
     7  [![Test Coverage](https://img.shields.io/codecov/c/github/elves/elvish.svg?logo=Codecov&label=coverage)](https://codecov.io/gh/elves/elvish)
     8  [![Go Report Card](https://goreportcard.com/badge/github.com/elves/elvish)](https://goreportcard.com/report/github.com/elves/elvish)
     9  [![GoDoc](https://img.shields.io/badge/godoc-api-blue.svg)](https://godoc.elv.sh)
    10  [![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/RealElvishShell)
    11  
    12  Elvish is a friendly interactive shell and an expressive programming language.
    13  It runs on Linux, BSDs, macOS and Windows. Despite its pre-1.0 status, it is
    14  already suitable for most daily interactive use.
    15  
    16  **Visit the official website https://elv.sh for prebuilt binaries, blog posts,
    17  documentation and other resources.**
    18  
    19  User groups (all connected with
    20  [matterbridge](https://github.com/42wim/matterbridge/)):
    21  [![Gitter](https://img.shields.io/badge/gitter-elves/elvish-blue.svg?logo=gitter-white)](https://gitter.im/elves/elvish)
    22  [![Telegram Group](https://img.shields.io/badge/telegram-@elvish-blue.svg)](https://telegram.me/elvish)
    23  [![#elvish on freenode](https://img.shields.io/badge/freenode-%23elvish-blue.svg)](https://webchat.freenode.net/?channels=elvish)
    24  [![#elvish:matrix.org](https://img.shields.io/badge/matrix-%23elvish:matrix.org-blue.svg)](https://matrix.to/#/#elvish:matrix.org)
    25  
    26  ## Building Elvish
    27  
    28  Most users can just use [prebuilt binaries](https://elv.sh/get/) and do not need
    29  to build from source.
    30  
    31  To build Elvish from source, you need
    32  
    33  -   A supported OS: Linux, {Free,Net,Open}BSD, macOS, or Windows.
    34  
    35      **NOTE**: Windows support is experimental, and only Windows 10 is supported.
    36  
    37  -   Go >= 1.14.
    38  
    39  To build Elvish from source, follow these steps:
    40  
    41  ```sh
    42  # 1. Start from any directory you want to store Elvish's source code
    43  # 2. Clone the Git repository
    44  git clone https://github.com/elves/elvish
    45  # 3. Change into the repository
    46  cd elvish
    47  # 4. Build and install Elvish
    48  make get
    49  ```
    50  
    51  This will install Elvish to `~/go/bin`.
    52  
    53  Alternatively, you can also just use `go get` to install Elvish:
    54  
    55  ```sh
    56  go get -u github.com/elves/elvish
    57  ```
    58  
    59  This will clone the Git repository to `~/go/src/github.com/elves/elvish`,
    60  updating it if already exists, and install Elvish to `~/go/bin`. However, Elvish
    61  built this way will lack version information, although it is otherwise fully
    62  functional.
    63  
    64  Some tips on installation:
    65  
    66  -   Remember to add `$HOME/go/bin` to your `PATH` so that you can run `elvish`
    67      directly.
    68  
    69  -   If you want to install Elvish to a different place, follow
    70      [these steps](https://github.com/golang/go/wiki/SettingGOPATH) to set
    71      `GOPATH`, and Elvish will be installed to `$GOPATH/bin` instead.
    72  
    73  ## Contributing to Elvish
    74  
    75  See [CONTRIBUTING.md](CONTRIBUTING.md) for more notes for contributors.