Added gitwash documentation after using the gitwash_dumper script to search and replace gitwash => nitime

1 files changed, 68 insertions, 0 deletions

diff --git a/doc/devel/set_up_fork.rst b/doc/devel/set_up_fork.rst
new file mode 100644
index 0000000..f2a42e7
--- /dev/null
+++ b/doc/devel/set_up_fork.rst
@@ -0,0 +1,68 @@
+.. _set-up-fork:
+
+==================
+ Set up your fork
+==================
+
+First you follow the instructions for :ref:`forking`. 
+
+Overview
+========
+
+::
+
+   git clone git@github.com/your-user-name/fperez.git
+   cd fperez
+   git remote add upstream git://github.com/fperez/fperez.git
+
+In detail
+=========
+
+Clone your fork
+---------------
+
+#. Clone your fork to the local computer with ``git clone
+   git@github.com:your-user-name/fperez.git``
+#. Investigate.  Change directory to your new repo: ``cd fperez``. Then
+   ``git branch -a`` to show you all branches.  You'll get something
+   like::
+
+      * master
+      remotes/origin/master
+
+   This tells you that you are currently on the ``master`` branch, and
+   that you also have a ``remote`` connection to ``origin/master``.
+   What remote repository is ``remote/origin``? Try ``git remote -v`` to
+   see the URLs for the remote.  They will point to your github_ fork.
+
+   Now you want to connect to the upstream `nitime github`_ repository, so
+   you can merge in changes from trunk.
+
+.. _linking-to-upstream:
+
+Linking your repository to the upstream repo
+--------------------------------------------
+
+::
+
+   cd fperez
+   git remote add upstream git://github.com/fperez/fperez.git
+
+``upstream`` here is just the arbitrary name we're using to refer to the
+main nitime_ repository at `nitime github`_.
+
+Note that we've used ``git://`` for the URL rather than ``git@``.  The
+``git://`` URL is read only.  This means we that we can't accidentally
+(or deliberately) write to the upstream repo, and we are only going to
+use it to merge into our own code.
+
+Just for your own satisfaction, show yourself that you now have a new
+'remote', with ``git remote -v show``, giving you something like::
+
+   upstream	git://github.com/fperez/fperez.git (fetch)
+   upstream	git://github.com/fperez/fperez.git (push)
+   origin	git@github.com:your-user-name/fperez.git (fetch)
+   origin	git@github.com:your-user-name/fperez.git (push)
+
+.. include:: git_links.txt
+