Add kind equalities to GHC.
[ghc.git] / README.md
1 Dependent Types Branch of GHC
2 =============================
3
4 This is a fork of GHC, with work toward supporting dependent types.
5 Anyone is welcome to download and play with this implementation,
6 and I am happy to receive feedback and issue reports on GitHub.
7
8 There are two options of using this branch:  manual, and Nix-based.
9
10 Manual
11 ------
12
13 This code should build, but I have tested it only on `DEBUG` settings;
14 I recommend using build style `devel2` in `build.mk`.
15
16 Here is a minimal script you can follow to build this at home;
17 see the [GHC Building Guide] [3] for more info.
18
19 ~~~
20 git clone https://github.com/goldfirere/ghc.git
21 cd ghc
22 git checkout nokinds
23 git remote set-url origin git://git.haskell.org/ghc.git   # so submodules work
24 git submodule update --init
25 cd mk
26 cp build.mk.sample build.mk
27 ## edit build.mk to uncomment the line to choose the `devel2` configuration
28 cd ..
29 perl boot
30 ./configure
31 make
32 ~~~
33
34 Check out the `testsuite/tests/dependent/should_compile` directory for
35 a few sample programs that should compile on this fork of GHC.
36
37 For more information about GHC, visit [GHC's web site][1].
38
39 Information for developers of GHC can be found on the [GHC Trac][2].
40
41 Nix-based
42 ---------
43
44 Thanks to @deepfire, this branch is available in Nixpkgs, which means that with
45 some effort it can be fairly automatically employed to build any package from
46 Hackage.  This way, though, requires that one installs the Nix package manager in
47 parallel with the system package manager -- and this option is currently
48 unavailable on Windows.
49
50 Here are the instructions:
51
52 1. To install the Nix package manager, taking over /nix for package storage:
53
54         curl https://nixos.org/nix/install | sh
55
56 2. Make Nix use the `master` repository of Nixpkgs package definitions:
57
58         git clone https://github.com/NixOS/nixpkgs.git
59         pushd ~/.nix-defexpr
60         rm -rf channels
61         ln -s ../nixpkgs
62         popd
63         echo 'export NIX_PATH=nixpkgs=/home/---<USERNAME>---/nixpkgs' >> ~/.bashrc
64         export NIX_PATH=nixpkgs=/home/---<USERNAME>---/nixpkgs
65
66 3. [OPTIONAL] To enable prebuilt binaries from Peter Simons/NixOS Hydra servers:
67
68         sudo mkdir /etc/nix
69         echo 'binary-caches = http://hydra.nixos.org/ http://hydra.cryp.to/' | sudo dd of=/etc/nix/nix.conf
70
71         # If you don't do that, everything will still work, just it'll have
72         # to build everything from source.
73
74 4. Enter a shell with `ghc-nokinds` available:
75
76         nix-shell -p haskell.compiler.ghcNokinds
77
78 5. See it's indeed `nokinds`:
79
80         wget https://raw.githubusercontent.com/goldfirere/ghc/nokinds/testsuite/tests/dependent/should_compile/KindEqualities2.hs
81         runhaskell KindEqualities2.hs
82
83 To apply 'nokinds' to building packages from Hackage, the best option would be
84 to follow instructions from the "Nix loves Haskell" talk by Peter Simons:
85
86    http://cryp.to/nixos-meetup-3-slides.pdf
87
88 ..where the relevant compiler name would be "ghcNokinds".
89
90 Building & Installing
91 =====================
92
93 For full information on building GHC, see the [GHC Building Guide] [3].
94 Here follows a summary - if you get into trouble, the Building Guide
95 has all the answers.
96
97 Before building GHC you may need to install some other tools and
98 libraries.  See, [Setting up your system for building GHC] [8].
99
100 *NB.* In particular, you need [GHC] [1] installed in order to build GHC,
101 because the compiler is itself written in Haskell.  You also need
102 [Happy] [4], [Alex] [5], and [Cabal] [9].  For instructions on how
103 to port GHC to a new platform, see the [GHC Building Guide] [3].
104
105 For building library documentation, you'll need [Haddock] [6].  To build
106 the compiler documentation, you need [Sphinx](http://www.sphinx-doc.org/)
107 and Xelatex (only for PDF output).
108
109 **Quick start**: the following gives you a default build:
110
111     $ ./boot
112     $ ./configure
113     $ make         # can also say 'make -jX' for X number of jobs
114     $ make install
115
116   On Windows, you need an extra repository containing some build tools.
117   These can be downloaded for you by configure. This only needs to be done once by running:
118
119     $ ./configure --enable-tarballs-autodownload
120
121 (NB: **Do you have multiple cores? Be sure to tell that to `make`!** This can
122 save you hours of build time depending on your system configuration, and is
123 almost always a win regardless of how many cores you have. As a simple rule,
124 you should have about N+1 jobs, where `N` is the amount of cores you have.)
125
126 The `./boot` step is only necessary if this is a tree checked out
127 from git.  For source distributions downloaded from [GHC's web site] [1],
128 this step has already been performed.
129
130 These steps give you the default build, which includes everything
131 optimised and built in various ways (eg. profiling libs are built).
132 It can take a long time.  To customise the build, see the file `HACKING`.
133
134 Filing bugs and feature requests
135 ================================
136
137 If you've encountered what you believe is a bug in GHC, or you'd like
138 to propose a feature request, please let us know! Submit a ticket in
139 our [bug tracker] [10] and we'll be sure to look into it. Remember:
140 **Filing a bug is the best way to make sure your issue isn't lost over
141 time**, so please feel free.
142
143 If you're an active user of GHC, you may also be interested in joining
144 the [glasgow-haskell-users] [11] mailing list, where developers and
145 GHC users discuss various topics and hang out.
146
147 Hacking & Developing GHC
148 ========================
149
150 Once you've filed a bug, maybe you'd like to fix it yourself? That
151 would be great, and we'd surely love your company! If you're looking
152 to hack on GHC, check out the guidelines in the `HACKING.md` file in
153 this directory - they'll get you up to speed quickly.
154
155 Contributors & Acknowledgements
156 ===============================
157
158 GHC in its current form wouldn't exist without the hard work of
159 [its many contributors] [12]. Over time, it has grown to include the
160 efforts and research of many institutions, highly talented people, and
161 groups from around the world. We'd like to thank them all, and invite
162 you to join!
163
164   [1]:  http://www.haskell.org/ghc/            "www.haskell.org/ghc/"
165   [2]:  http://ghc.haskell.org/trac/ghc    "ghc.haskell.org/trac/ghc"
166   [3]:  http://ghc.haskell.org/trac/ghc/wiki/Building
167           "ghc.haskell.org/trac/ghc/wiki/Building"
168   [4]:  http://www.haskell.org/happy/          "www.haskell.org/happy/"
169   [5]:  http://www.haskell.org/alex/           "www.haskell.org/alex/"
170   [6]:  http://www.haskell.org/haddock/        "www.haskell.org/haddock/"
171   [7]: https://ghc.haskell.org/trac/ghc/wiki/Building/GettingTheSources#GettingaGHCrepositoryfromGitHub
172           "https://ghc.haskell.org/trac/ghc/wiki/Building/GettingTheSources#GettingaGHCrepositoryfromGitHub"
173   [8]:  http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
174           "http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation"
175   [9]:  http://www.haskell.org/cabal/          "http://www.haskell.org/cabal/"
176   [10]: http://ghc.haskell.org/trac/ghc/
177           "http://ghc.haskell.org/trac/ghc/"
178   [11]: http://www.haskell.org/pipermail/glasgow-haskell-users/
179           "http://www.haskell.org/pipermail/glasgow-haskell-users/"
180   [12]: http://ghc.haskell.org/trac/ghc/wiki/TeamGHC
181           "http://ghc.haskell.org/trac/ghc/wiki/TeamGHC"