diff options
| author | Will Thompson <will@willthompson.co.uk> | 2018-07-05 09:54:39 +0100 |
|---|---|---|
| committer | Will Thompson <will@willthompson.co.uk> | 2018-07-05 09:57:39 +0100 |
| commit | 2eb3cff63e73794078b15c891d8b8b6354a81086 (patch) | |
| tree | 0cbdb6b07c1f52be68e98bf7839bc3898aea1e8c /CONTRIBUTING.md | |
| parent | 887a8b92580eaf50653162da19bdb8b648a62530 (diff) | |
Encourage contributors to use 'stack'
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35a5b8a..6d91878 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,28 @@ Want to get involved? Great! ============================ +Make sure you have an up-to-date Haskell toolchain. I recommend using +[Stack](https://haskellstack.org/) for development. Make sure you run `stack +update` if you install it from a distro package before continuing. + Grab the latest code from git: git clone https://gitlab.freedesktop.org/bustle/bustle.git + cd bustle + +Build it: + + stack build + +Run it: + + stack exec bustle + +Test it: + + stack test -and get stuck in! Please file bugs and merge requests at +Please file bugs and merge requests at <https://gitlab.freedesktop.org/bustle/bustle>. In new code, try to follow @@ -31,7 +48,7 @@ cp dist/bustle-x.y.z* x.y.z/ scp -r x.y.z annarchy.freedesktop.org:/srv/www.freedesktop.org/www/software/bustle/ # Upload source to Hackage -cabal upload +stack upload git push origin --tags master ``` |