ghcup/README.md

109 lines
3.6 KiB
Markdown
Raw Normal View History

2018-10-16 06:41:42 +00:00
[![GitHub release](https://img.shields.io/github/release/haskell/ghcup.svg)](https://github.com/haskell/ghcup/releases)
[![Build Status](https://travis-ci.org/haskell/ghcup.svg?branch=master)](https://travis-ci.org/haskell/ghcup)
[![license](https://img.shields.io/github/license/haskell/ghcup.svg)](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).
In addition this script can also install `cabal-install`.
2018-10-17 02:19:51 +00:00
**Note: this project is in early stage and may not work on all distributions yet!**
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
2018-10-16 06:43:29 +00:00
`cabal new-*` manages your haskell packages, but not GHC versions, since
it follows the unix philosophy. Unfortunately system GHC versions
2018-09-29 09:27:45 +00:00
are often either outdated or cannot be installed in parallel
2018-10-16 06:43:29 +00:00
with proper symlink management on many distros. This tool
tries to fill that gap and be fairly distro-agnostic.
2018-09-29 09:27:45 +00:00
Inspired by [rustup](https://github.com/rust-lang-nursery/rustup.rs).
## Installation
2018-10-15 14:15:57 +00:00
Just place the `ghcup` shell script into your `PATH` anywhere.
E.g.:
2018-09-29 09:27:45 +00:00
2018-10-15 16:22:37 +00:00
```sh
2018-10-15 14:24:14 +00:00
mkdir -p ~/.local/bin
2018-10-16 06:41:42 +00:00
curl https://raw.githubusercontent.com/haskell/ghcup/master/ghcup > ~/.local/bin/ghcup
chmod +x ~/.local/bin/ghcup
```
2018-10-15 16:22:37 +00:00
Then adjust your `PATH` in `~/.bashrc` (or similar, depending on your shell) like so, for example:
```sh
export PATH="$HOME/.cabal/bin:$HOME/.ghcup/bin:$HOME/.local/bin:$PATH"
```
2018-09-29 09:27:45 +00:00
## 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-10-16 06:41:42 +00:00
- [ ] FreeBSD support ([#4](https://github.com/haskell/ghcup/issues/4))
- [ ] Make fetching tarballs more robust ([#5](https://github.com/haskell/ghcup/issues/5))
2018-09-30 05:52:01 +00:00
- [x] More code documentation
2018-10-16 06:41:42 +00:00
- [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))
2018-09-29 09:27:45 +00:00
## Known problems
### Precompiled binaries
2018-09-29 09:27:45 +00:00
Since this uses precompiled binaries you may run into
2018-10-15 15:24:09 +00:00
problems with *ncurses* and **missing libtinfo**, in case
2018-09-29 09:27:45 +00:00
your distribution doesn't use the legacy way of building
ncurses and has no compatibility symlinks in place.
2018-10-15 15:24:09 +00:00
Ask your distributor on how to solve this or
try to compile from source via `ghcup compile <version>`.
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`.
### Compilation
2018-10-02 17:33:47 +00:00
Although this script can compile GHC for you, it's just a very thin
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
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.