Update README and add badges

This commit is contained in:
Adelbert Chang 2018-04-23 21:48:19 -07:00
parent c4a79a15b9
commit 46d65dcdf5

View file

@ -1,5 +1,8 @@
# hnix
[![Build Status](https://api.travis-ci.org/haskell-nix/hnix.svg)](https://travis-ci.org/haskell-nix/hnix)
[![Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/haskell-nix/hnix)
Haskell parser, evaluator and type checker for the Nix language.
## Prerequisites
@ -10,7 +13,7 @@ for interacting with store paths, until `hnix-store` is ready.
## Getting Started
```bash
$ git clone --recursive https://github.com/jwiegley/hnix.git
$ git clone --recursive https://github.com/haskell-nix/hnix.git
...
$ cd hnix
$ nix-shell
@ -61,11 +64,11 @@ $ ./dist/build/hnix/hnix <args> +RTS -p
## How you can help
If you're looking for a way to help out, try taking a look
[here](https://github.com/jwiegley/hnix/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee).
[here](https://github.com/haskell-nix/hnix/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee).
When you find an issue that looks interesting to you, comment on the ticket to
let others know you're working on it; look for others who might have done the
same. You can talk with everyone live on
[gitter](https://gitter.im/haskell-nix/Lobby).
[Gitter](https://gitter.im/haskell-nix/hnix).
When you're ready to submit a pull request, test it with:
```