diff options
author | Austin Seipp <austin@well-typed.com> | 2015-12-11 17:31:23 -0600 |
---|---|---|
committer | Austin Seipp <austin@well-typed.com> | 2015-12-11 17:31:23 -0600 |
commit | 518310915fa2298f105a2ff5facd4c1ef796717d (patch) | |
tree | d81af3b908aa9a9b4470ce860831abe8cc18e528 /README.md | |
parent | 6746549772c5cc0ac66c0fce562f297f4d4b80a2 (diff) | |
download | haskell-518310915fa2298f105a2ff5facd4c1ef796717d.tar.gz |
Revert README.md changes from 6746549772c5
Signed-off-by: Austin Seipp <austin@well-typed.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 90 |
1 files changed, 19 insertions, 71 deletions
@@ -1,91 +1,39 @@ -Dependent Types Branch of GHC -============================= +The Glasgow Haskell Compiler +============================ -This is a fork of GHC, with work toward supporting dependent types. -Anyone is welcome to download and play with this implementation, -and I am happy to receive feedback and issue reports on GitHub. +[![Build Status](https://api.travis-ci.org/ghc/ghc.svg?branch=master)](http://travis-ci.org/ghc/ghc) -There are two options of using this branch: manual, and Nix-based. +This is the source tree for [GHC][1], a compiler and interactive +environment for the Haskell functional programming language. -Manual ------- - -This code should build, but I have tested it only on `DEBUG` settings; -I recommend using build style `devel2` in `build.mk`. - -Here is a minimal script you can follow to build this at home; -see the [GHC Building Guide] [3] for more info. - -~~~ -git clone https://github.com/goldfirere/ghc.git -cd ghc -git checkout nokinds -git remote set-url origin git://git.haskell.org/ghc.git # so submodules work -git submodule update --init -cd mk -cp build.mk.sample build.mk -## edit build.mk to uncomment the line to choose the `devel2` configuration -cd .. -perl boot -./configure -make -~~~ - -Check out the `testsuite/tests/dependent/should_compile` directory for -a few sample programs that should compile on this fork of GHC. - -For more information about GHC, visit [GHC's web site][1]. +For more information, visit [GHC's web site][1]. Information for developers of GHC can be found on the [GHC Trac][2]. -Nix-based ---------- - -Thanks to @deepfire, this branch is available in Nixpkgs, which means that with -some effort it can be fairly automatically employed to build any package from -Hackage. This way, though, requires that one installs the Nix package manager in -parallel with the system package manager -- and this option is currently -unavailable on Windows. - -Here are the instructions: - -1. To install the Nix package manager, taking over /nix for package storage: - - curl https://nixos.org/nix/install | sh - -2. Make Nix use the `master` repository of Nixpkgs package definitions: - git clone https://github.com/NixOS/nixpkgs.git - pushd ~/.nix-defexpr - rm -rf channels - ln -s ../nixpkgs - popd - echo 'export NIX_PATH=nixpkgs=/home/---<USERNAME>---/nixpkgs' >> ~/.bashrc - export NIX_PATH=nixpkgs=/home/---<USERNAME>---/nixpkgs +Getting the Source +================== -3. [OPTIONAL] To enable prebuilt binaries from Peter Simons/NixOS Hydra servers: +There are two ways to get a source tree: - sudo mkdir /etc/nix - echo 'binary-caches = http://hydra.nixos.org/ http://hydra.cryp.to/' | sudo dd of=/etc/nix/nix.conf + 1. *Download source tarballs* - # If you don't do that, everything will still work, just it'll have - # to build everything from source. + Download the GHC source distribution: -4. Enter a shell with `ghc-nokinds` available: + ghc-<version>-src.tar.bz2 - nix-shell -p haskell.compiler.ghcNokinds + which contains GHC itself and the "boot" libraries. -5. See it's indeed `nokinds`: + 2. *Check out the source code from git* - wget https://raw.githubusercontent.com/goldfirere/ghc/nokinds/testsuite/tests/dependent/should_compile/KindEqualities2.hs - runhaskell KindEqualities2.hs + $ git clone --recursive git://git.haskell.org/ghc.git -To apply 'nokinds' to building packages from Hackage, the best option would be -to follow instructions from the "Nix loves Haskell" talk by Peter Simons: + Note: cloning GHC from Github requires a special setup. See [Getting a GHC + repository from Github] [7]. - http://cryp.to/nixos-meetup-3-slides.pdf + **DO NOT submit pull request directly to the github repo.** + *See the GHC team's working conventions re [how to contribute a patch to GHC](http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/FixingBugs "ghc.haskell.org/trac/ghc/wiki/WorkingConventions/FixingBug").* -..where the relevant compiler name would be "ghcNokinds". Building & Installing ===================== |