diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1976775 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing + +* PR or email +* this script is POSIX shell +* use [shellcheck](https://github.com/koalaman/shellcheck) and `checkbashisms.pl` from [debian devscripts](http://http.debian.net/debian/pool/main/d/devscripts/devscripts_2.18.4.tar.xz) +* whitespaces, no tabs + +## Adding a new distro, updating GHC versions, ... + +This script makes use of two files: + +1. [.download-urls](https://raw.githubusercontent.com/haskell/ghcup/master/.download-urls), + which is meta information on what binary tarball to download for the given version, architecture and distribution. + If you know your distribution XY works with a tarball, add a `=` key to that line. `` + will be the fallback and after that `unknown`. Lines are unique per tarball url. +2. [.available-versions](https://raw.githubusercontent.com/haskell/ghcup/master/.available-versions), + which just lists available upstream versions and tags. + +## TODO + +- [ ] FreeBSD support ([#4](https://github.com/haskell/ghcup/issues/4)) +- [x] Make fetching tarballs more robust ([#5](https://github.com/haskell/ghcup/issues/5)) +- [x] More code documentation +- [x] Allow to compile from source ([#2](https://github.com/haskell/ghcup/issues/2)) +- [x] Allow to install cabal-install as well ([#3](https://github.com/haskell/ghcup/issues/3)) diff --git a/README.md b/README.md index aaee437..70e9f5c 100644 --- a/README.md +++ b/README.md @@ -52,24 +52,6 @@ Alternatively, you can also tell it to compile from source (note that this might In addition this script can also install `cabal-install`. -## Contributing - -* PR or email -* this script is POSIX shell -* use [shellcheck](https://github.com/koalaman/shellcheck) and `checkbashisms.pl` from [debian devscripts](http://http.debian.net/debian/pool/main/d/devscripts/devscripts_2.18.4.tar.xz) -* whitespaces, no tabs - -### Download locations - -Download locations are maintained in the file [.download-urls](https://raw.githubusercontent.com/haskell/ghcup/master/.download-urls) -and may slightly be behind a very recent release or not tested -on all distro combinations. - -In such a case, consider providing a PR to fix it. - -Similarly, available versions are maintained in -[.available-versions](https://raw.githubusercontent.com/haskell/ghcup/master/.available-versions). - ## Known problems ### Limited distributions supported