Add design goals to README

This commit is contained in:
Julian Ospald 2018-11-24 19:35:17 +08:00
parent b7fd47373a
commit 17fe22202e
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
1 changed files with 15 additions and 0 deletions

View File

@ -13,6 +13,7 @@ Similar in scope to [rustup](https://github.com/rust-lang-nursery/rustup.rs), [p
* [Installation](#installation)
* [Usage](#usage)
* [Design goals](#design-goals)
* [How](#how)
* [Known problems](#known-problems)
@ -54,6 +55,20 @@ cabal new-install cabal-install
Generally this is meant to be used with [`cabal-install`](https://hackage.haskell.org/package/cabal-install), which
handles your haskell packages and can demand that [a specific version](https://cabal.readthedocs.io/en/latest/nix-local-build.html#cfg-flag---with-compiler) of `ghc` is available, which `ghcup` can do.
## Design goals
1. simplicity
2. non-interactive
3. portable
4. do one thing and do it well (UNIX philosophy)
### Non-goals
1. invoking `sudo`, `apt-get` or *any* package manager
2. handling system packages
3. handling cabal projects
4. being a stack alternative
## How
Installs a specified GHC version into `~/.ghcup/ghc/<ver>`, and places `ghc-<ver>` symlinks in `~/.ghcup/bin/`.