X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=pep-git.txt;h=a2e2780905cb3d8699dd56bbd0fb0e1f760a3f02;hb=addfd31ba0339c2e4c36f777dee7d7585735c2dc;hp=a8f604520cb9e52bb1e6f0aa9dae88cae7a1e8db;hpb=0f6e6e2f62329e02580c81cc7229df155320812c;p=git-wiki.git diff --git a/pep-git.txt b/pep-git.txt index a8f6045..a2e2780 100644 --- a/pep-git.txt +++ b/pep-git.txt @@ -23,6 +23,7 @@ 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 ============= @@ -58,6 +59,49 @@ many different languages. Download Russian translation from `GArik `Git Wiki `_. +Offline documentation +--------------------- + +Git has builtin help: run ``git help TOPIC``. For example, run +``git help git`` or ``git help help``. + + +Quick start +=========== + +Download and installation +------------------------- + +Unix users: download and install using your package manager. + +Microsoft Windows: download `git-for-windows +`_. + +MacOS X: use git installed with `XCode +`_ or download +`git-osx-installer +`_. + +Initial configuration +--------------------- + +This simple code is often appears in documentation, but it is +important so let repeat it here:: + + $ git config --global user.name "User Name" + $ git config --global user.email user.name@example.org + + +Examples in this PEP +==================== + +Examples of git commands in this PEP use the following approach. It is +supposed that you, the user, works with a local repository named +``python`` that has an upstream remote repo named ``origin``. Your +local repo has two branches ``v1`` and ``v2``. Usually the currently +checked out branch is ``v2``. + + References ==========