summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas Miedema <thomasmiedema@gmail.com>2014-06-21 01:07:59 +0200
committerAustin Seipp <austin@well-typed.com>2014-08-19 05:54:45 -0500
commit89f5f314e32c3e80c71f4b3dcc8835ae74d7d57f (patch)
tree6333671a614b4771c15a6a55ff0392b552d86cbb /README.md
parente3c3586d717e6f1eb0e80f25b29a16de6c0f6d5c (diff)
downloadhaskell-89f5f314e32c3e80c71f4b3dcc8835ae74d7d57f.tar.gz
Explain how to clone GitHub forks. Ticket #8379.
This information is mirrored at: http://ghc.haskell.org/trac/ghc/wiki/Building/GettingTheSources#GettingaGHCrepositoryfromGitHub Signed-off-by: Austin Seipp <austin@well-typed.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/README.md b/README.md
index f35df7256b..32234c0d24 100644
--- a/README.md
+++ b/README.md
@@ -26,16 +26,18 @@ There are two ways to get a source tree:
2. *Check out the source code from git*
- First clone the GHC github read-only repository:
+ The official mirror for GHC on GitHub is located at https://github.com/ghc/ghc.
$ git clone git://github.com/ghc/ghc.git
-
- Then run the `sync-all` script in that repository to get the other repositories:
-
$ cd ghc
$ ./sync-all get
- This checks out the "boot" packages.
+ If you want to clone your own fork instead, add an argument to `sync-all` to
+ tell it where it can find the other repositories it needs.
+
+ $ git clone <your preferred github.com GHC fork URL> ghc
+ $ cd ghc
+ $ ./sync-all -r git://github.com/ghc get
**DO NOT submit pull request directly to the github repo.**
*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").*
@@ -132,5 +134,5 @@ you to join!
"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://ghc.haskell.org/trac/ghc/wiki/Contributors
- "http://ghc.haskell.org/trac/ghc/wiki/Contributors"
+ [12]: http://ghc.haskell.org/trac/ghc/wiki/TeamGHC
+ "http://ghc.haskell.org/trac/ghc/wiki/TeamGHC"