2018-09-29 15:29:45 +00:00
[](https://travis-ci.org/hasufell/ghcup)
2018-09-29 15:31:07 +00:00
[](COPYING)
2018-09-29 15:29:45 +00:00
2018-09-29 09:27:45 +00:00
# GHC up
2018-09-29 15:34:17 +00:00
Installs a specified GHC version into `~/.ghcup/ghc/<ver>` ,
2018-09-29 09:27:45 +00:00
and places `ghc-<ver>` etc. symlinks in `~/.ghcup/bin/` .
Additionally allows to manage currently selected ghc
via unversioned symlinks.
This uses precompiled GHC binaries that have been
compiled on fedora/debian by
[upstream GHC ](https://www.haskell.org/ghc/download_ghc_8_6_1.html#binaries ).
2018-09-30 11:39:40 +00:00
Alternatively, you can also tell it to compile from source (note that this might
fail due to missing requirements).
2018-09-30 10:30:11 +00:00
In addition this script can also install `cabal-install` .
2018-09-29 17:00:12 +00:00
## Table of Contents
* [Why ](#why )
* [Installation ](#installation )
* [Usage ](#usage )
* [Contributing ](#contributing )
* [TODO ](#todo )
* [Known problems ](#known-problems )
2018-09-29 09:27:45 +00:00
## Why
I don't use stack, but `cabal new-*` and system GHC versions
are often either outdated or cannot be installed in parallel
with proper symlink management.
Inspired by [rustup ](https://github.com/rust-lang-nursery/rustup.rs ).
## Installation
2018-09-29 17:17:14 +00:00
Just place the `ghcup` shell script into your PATH anywhere
2018-09-29 09:27:45 +00:00
(preferably `~/.local/bin` ).
## Usage
2018-09-29 17:17:14 +00:00
See `ghcup --help` .
2018-09-29 09:27:45 +00:00
2018-09-29 15:18:58 +00:00
## 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
2018-09-29 09:27:45 +00:00
## TODO
2018-09-29 17:11:03 +00:00
- [ ] FreeBSD support ([#4](https://github.com/hasufell/ghcup/issues/4))
- [ ] Make fetching tarballs more robust ([#5](https://github.com/hasufell/ghcup/issues/5))
2018-09-30 05:52:01 +00:00
- [x] More code documentation
2018-09-30 11:39:40 +00:00
- [x] Allow to compile from source ([#2](https://github.com/hasufell/ghcup/issues/2))
2018-09-30 08:46:50 +00:00
- [x] Allow to install cabal-install as well ([#3](https://github.com/hasufell/ghcup/issues/3))
2018-09-29 16:55:43 +00:00
2018-09-29 09:27:45 +00:00
## Known problems
2018-10-01 06:04:21 +00:00
### Precompiled binaries
2018-09-29 09:27:45 +00:00
Since this uses precompiled binaries you may run into
problems with ncurses and missing libtinfo, in case
your distribution doesn't use the legacy way of building
ncurses and has no compatibility symlinks in place.
Ask your distributor on how to solve this.
2018-10-01 06:04:21 +00:00
2018-10-02 17:33:47 +00:00
### Unreliable download location
There is no single reliable URL where to download future
GHC binary releases from, since the tarball names contain
the distro name and version they were built on. As such,
we cannot foresee what will be the next tarball name.
In such a case, consider to update this script via
`ghcup self-update` .
2018-10-01 06:04:21 +00:00
### Compilation
2018-10-02 17:33:47 +00:00
Although this script can compile GHC for you, it's just a very thin
2018-10-01 06:04:21 +00:00
wrapper around the build system. It makes no effort in trying
2018-10-01 06:15:02 +00:00
to figure out whether you have the correct toolchain and
2018-10-01 06:04:21 +00:00
the correct dependencies. Refer to [the official docs ](https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Linux )
on how to prepare your environment for building GHC.
