Follow-up to #13887, for promoted infix constructors
[ghc.git] / README.md
index ac97f34..02bf4a8 100644 (file)
--- a/README.md
+++ b/README.md
-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
+  *See the GHC team's working conventions regarding [how to contribute a patch to GHC](http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/FixingBugs).* First time contributors are encouraged to get started by just sending a Pull Request.
 
-..where the relevant compiler name would be "ghcNokinds".
 
 Building & Installing
 =====================
 
-For full information on building GHC, see the [GHC Building Guide] [3].
+For full information on building GHC, see the [GHC Building Guide][3].
 Here follows a summary - if you get into trouble, the Building Guide
 has all the answers.
 
 Before building GHC you may need to install some other tools and
-libraries.  See, [Setting up your system for building GHC] [8].
+libraries.  See, [Setting up your system for building GHC][8].
 
-*NB.* In particular, you need [GHC] [1] installed in order to build GHC,
+*NB.* In particular, you need [GHC][1] installed in order to build GHC,
 because the compiler is itself written in Haskell.  You also need
-[Happy] [4], [Alex] [5], and [Cabal] [9].  For instructions on how
-to port GHC to a new platform, see the [GHC Building Guide] [3].
+[Happy][4], [Alex][5], and [Cabal][9].  For instructions on how
+to port GHC to a new platform, see the [GHC Building Guide][3].
 
-For building library documentation, you'll need [Haddock] [6].  To build
+For building library documentation, you'll need [Haddock][6].  To build
 the compiler documentation, you need [Sphinx](http://www.sphinx-doc.org/)
 and Xelatex (only for PDF output).
 
@@ -124,24 +71,24 @@ almost always a win regardless of how many cores you have. As a simple rule,
 you should have about N+1 jobs, where `N` is the amount of cores you have.)
 
 The `./boot` step is only necessary if this is a tree checked out
-from git.  For source distributions downloaded from [GHC's web site] [1],
+from git.  For source distributions downloaded from [GHC's web site][1],
 this step has already been performed.
 
 These steps give you the default build, which includes everything
 optimised and built in various ways (eg. profiling libs are built).
-It can take a long time.  To customise the build, see the file `HACKING`.
+It can take a long time.  To customise the build, see the file `HACKING.md`.
 
 Filing bugs and feature requests
 ================================
 
 If you've encountered what you believe is a bug in GHC, or you'd like
 to propose a feature request, please let us know! Submit a ticket in
-our [bug tracker] [10] and we'll be sure to look into it. Remember:
+our [bug tracker][10] and we'll be sure to look into it. Remember:
 **Filing a bug is the best way to make sure your issue isn't lost over
 time**, so please feel free.
 
 If you're an active user of GHC, you may also be interested in joining
-the [glasgow-haskell-users] [11] mailing list, where developers and
+the [glasgow-haskell-users][11] mailing list, where developers and
 GHC users discuss various topics and hang out.
 
 Hacking & Developing GHC
@@ -156,7 +103,7 @@ Contributors & Acknowledgements
 ===============================
 
 GHC in its current form wouldn't exist without the hard work of
-[its many contributors] [12]. Over time, it has grown to include the
+[its many contributors][12]. Over time, it has grown to include the
 efforts and research of many institutions, highly talented people, and
 groups from around the world. We'd like to thank them all, and invite
 you to join!