diff --git a/README.md b/README.md index 514912e..c796cb2 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Similar in scope to [rustup](https://github.com/rust-lang-nursery/rustup.rs), [p * [Configuration](#configuration) * [Manpages](#manpages) * [Shell-completion](#shell-completion) - * [Cross support](#cross-support) + * [Compiling from sourc](#compiling-from-source) * [XDG support](#xdg-support) * [Env variables](#env-variables) * [Installing custom bindists](#installing-custom-bindists) @@ -109,7 +109,18 @@ as e.g. `/etc/bash_completion.d/ghcup` (depending on distro) and make sure your bashrc sources the startup script (`/usr/share/bash-completion/bash_completion` on some distros). -### Cross support +### Compiling from source + +Compiling from source is supported for both source tarballs and arbitrary git refs. See `ghcup compile ghc --help` +for a list of all available options. + +If you need to overwrite the existing `build.mk`, check the default files +in [data/build_mk](./data/build_mk), copy them somewhere, adjust them and +pass `--config path/to/build.mk` to `ghcup compile ghc`. + +Make sure your system meets all the [prerequisites](https://gitlab.haskell.org/ghc/ghc/-/wikis/building/preparation). + +#### Cross support ghcup can compile and install a cross GHC for any target. However, this requires that the build host has a complete cross toolchain and various