Add offline documentation

[git-wiki.git] / pep-git.txt

diff --git a/pep-git.txt b/pep-git.txt
index 2a2c67633d6175aefd2f9a838ad1759314c22f06..595cea4b2851df1e0c401beb83d1bd233b2407f7 100644 (file)
--- a/pep-git.txt
+++ b/pep-git.txt
@@ -1,5 +1,5 @@
 PEP: XXX
-Title: git
+Title: Collecting information about git
 Version: $Revision$
 Last-Modified: $Date$
 Author: Oleg Broytman <phd@phdru.name>
@@ -12,10 +12,63 @@ Post-History:
 Abstract
 ========
 
+This Informational PEP collects information about git. There is, of
+course, a lot of documentation for git, so the PEP concentrates on
+more complex issues, topics and scenarios.
+
+The plan is to extend the PEP in the future collecting information
+about equivalence of Mercurial and git scenarios to help migrating
+Python development from Mercurial to git.
+
+The author of the PEP doesn't currently plan to write a Process PEP on
+migration from Mercurial to git.
+
+Documentation
+=============
+
+Git is accompanied with a lot of documentation, both online and
+offline.
+
+Documentation for starters
+--------------------------
+
+Git Tutorial: `part 1
+<https://www.kernel.org/pub/software/scm/git/docs/gittutorial.html>`_,
+`part 2
+<https://www.kernel.org/pub/software/scm/git/docs/gittutorial-2.html>`_.
+
+`Git User's manual
+<https://www.kernel.org/pub/software/scm/git/docs/user-manual.html>`_.
+`Everyday GIT With 20 Commands Or So
+<https://www.kernel.org/pub/software/scm/git/docs/everyday.html>`_.
+`Git workflows
+<https://www.kernel.org/pub/software/scm/git/docs/gitworkflows.html>`_.
+
+`Git Magic
+<http://www-cs-students.stanford.edu/~blynn/gitmagic/index.html>`_,
+also with a number of translations.
+
+Advanced documentation
+----------------------
+
+`Pro Git <https://git-scm.com/book>`_. The Book about git. Buy it at
+Amazon or download in PDF, mobi, or ePub form. Has translations to
+many different languages. Download Russian translation from `GArik
+<https://github.com/GArik/progit/wiki>`_.
+
+`Git Wiki <https://git.wiki.kernel.org/index.php/Main_Page>`_.
+
+Offline documentation
+---------------------
+
+Git has builtin help: run ``git help TOPIC``. For example, run
+``git help git`` or ``git help help``.
 
 References
 ==========
 
+.. [] 
+
 
 Copyright
 =========