Package keys (for linking/type equality) separated from package IDs.
[ghc.git] / README.md
index 3b3a66e..f35df72 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
 The Glasgow Haskell Compiler
 ============================
 
-This is the source tree for [GHC] [1], a compiler and interactive
+[![Build Status](https://api.travis-ci.org/ghc/ghc.svg?branch=master)](http://travis-ci.org/ghc/ghc)
+
+This is the source tree for [GHC][1], a compiler and interactive
 environment for the Haskell functional programming language.
 
-For more information, 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].
+Information for developers of GHC can be found on the [GHC Trac][2].
 
 
 Getting the Source
@@ -36,7 +38,7 @@ There are two ways to get a source tree:
   This checks out the "boot" packages.
 
   **DO NOT submit pull request directly to the github repo.**
-  *See the GHC developer team's working conventions re [contributing patches](http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions/Git#Contributingpatches "hackage.haskell.org/trac/ghc/wiki/WorkingConventions/Git#Contributingpatches").*
+  *See the GHC developer team's working conventions re [contributing patches](http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/Git#Contributingpatches "ghc.haskell.org/trac/ghc/wiki/WorkingConventions/Git#Contributingpatches").*
 
 
 Building & Installing
@@ -62,9 +64,14 @@ dblatex.
 
     $ perl boot
     $ ./configure
-    $ make
+    $ make         # can also say 'make -jX' for X number of jobs
     $ make install
 
+(NB: **Do you have multiple cores? Be sure to tell that to `make`!** This can
+save you hours of build time depending on your system configuration, and is
+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 `perl boot` step is only necessary if this is a tree checked out
 from git.  For source distributions downloaded from [GHC's web site] [1],
 this step has already been performed.
@@ -110,20 +117,20 @@ groups from around the world. We'd like to thank them all, and invite
 you to join!
 
   [1]:  http://www.haskell.org/ghc/            "www.haskell.org/ghc/"
-  [2]:  http://hackage.haskell.org/trac/ghc    "hackage.haskell.org/trac/ghc"
-  [3]:  http://hackage.haskell.org/trac/ghc/wiki/Building
-          "hackage.haskell.org/trac/ghc/wiki/Building"
+  [2]:  http://ghc.haskell.org/trac/ghc    "ghc.haskell.org/trac/ghc"
+  [3]:  http://ghc.haskell.org/trac/ghc/wiki/Building
+          "ghc.haskell.org/trac/ghc/wiki/Building"
   [4]:  http://www.haskell.org/happy/          "www.haskell.org/happy/"
   [5]:  http://www.haskell.org/alex/           "www.haskell.org/alex/"
   [6]:  http://www.haskell.org/haddock/        "www.haskell.org/haddock/"
-  [7]:  http://hackage.haskell.org/trac/ghc/wiki/Building/SyncAll
-          "http://hackage.haskell.org/trac/ghc/wiki/Building/SyncAll"
-  [8]:  http://hackage.haskell.org/trac/ghc/wiki/Building/Preparation
-          "http://hackage.haskell.org/trac/ghc/wiki/Building/Preparation"
+  [7]:  http://ghc.haskell.org/trac/ghc/wiki/Building/SyncAll
+          "http://ghc.haskell.org/trac/ghc/wiki/Building/SyncAll"
+  [8]:  http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
+          "http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation"
   [9]:  http://www.haskell.org/cabal/          "http://www.haskell.org/cabal/"
-  [10]: http://hackage.haskell.org/trac/ghc/
-          "http://hackage.haskell.org/trac/ghc/"
+  [10]: http://ghc.haskell.org/trac/ghc/
+          "http://ghc.haskell.org/trac/ghc/"
   [11]: http://www.haskell.org/pipermail/glasgow-haskell-users/
           "http://www.haskell.org/pipermail/glasgow-haskell-users/"
-  [12]: http://hackage.haskell.org/trac/ghc/wiki/Contributors
-          "http://hackage.haskell.org/trac/ghc/wiki/Contributors"
+  [12]: http://ghc.haskell.org/trac/ghc/wiki/Contributors
+          "http://ghc.haskell.org/trac/ghc/wiki/Contributors"