Changes between Initial Version and Version 1 of code/tools/Git

Timestamp:

Jan 27, 2010, 12:35:55 AM (15 years ago)

Author:

adrfried

Comment:

started some documentation for using git

code/tools/Git

@@ +1 @@
+= Using Git for Orxonox =
+
+Git may be used by experienced users, who want to use Git's advanced features for developing Orxonox.
+
+== Initial Checkout ==
+
+To checkout orxonox' [wiki:SVN]-Repository in Git use:
+
+{{{
+git svn clone --stdlayout --prefix=svn/ https://svn.orxonox.net/game/code orxonox
+}}}
+
+This will check out the whole history of the Project code with all the branches and tags, it will use about 150 MB of disk space and it may take a long time (while checking out it will use more disk space, until things get automatically compressed by {{{git gc}}}).
+
+== Basic Configuration ==
+
+Set your full name and email address:
+
+{{{
+git config --global user.name "Your Name Comes Here"
+git config --global user.email you@yourdomain.example.com
+}}}
+
+Some fancy colors:
+
+{{{
+git config --global color.ui auto
+}}}
+
+The --global argument tells git to store the config in .gitconfig in your home, so these will be usable for every git repository you have.
+
+Add something like this to your .bashrc for having a nice, git-aware bash prompt, which shows the current branch you are on and sometimes some other stuff:
+
+{{{
+PS1='\u@\h:\w$(__git_ps1 " (%s)")\$ '
+}}}
+
+== Basic Usage ==
+
+Pull changes from SVN to your local Git Repository:
+
+{{{
+git svn rebase
+}}}
+
+Commit local changes and push them to the SVN:
+
+{{{
+git commit -a
+git svn dcommit
+}}}
+
+== Branches ==
+
+TBD.
+
+== Documentation ==
+
+To learn more about git see: http://git-scm.com/documentation