(Commit created by redmine exporter script from page "NamesWeapons" version 12)

[xonotic/xonotic.wiki.git] / Repository_Access.textile

diff --git a/Repository_Access.textile b/Repository_Access.textile
index 5005537fdd4afa56de76d0c5c286c620980027fa..7c80d82ab65adc721b4d082ddcca78bc87a6f324 100644 (file)
--- a/Repository_Access.textile
+++ b/Repository_Access.textile
@@ -1,10 +1,16 @@
 h1. Repository Access
 
-The repository is accessed using git.
+{{>toc}}
+
+Xonotic uses several GIT repositories. There's a helperscript in the main repository to aid in checking out all relevant repositories and help you building and running Xonotic.
+The repository also contains several branches next to the stable "master" branch. So if you're interested in the progress of a certain feature, or want to help or create a new one, checkout the appropriate branches.
+For information on how to obtain write access, skip down to the [[Repository Access#Getting write access|Getting write access]]" section.
+
+For more information about git we have a [[Git]] page on the wiki [[Git|here]].
 
 h2. Linux/OS X:
 
-First, you install git using your favorite package manager. Then:
+First, you install git using your favorite package manager. Then, do the following to download and compile (execute the first line only to download)::
 
 <pre>
 git clone git://git.xonotic.org/xonotic/xonotic.git
@@ -12,9 +18,17 @@ cd xonotic
 ./all update
 </pre>
 
+The git:// protocol uses port 9418, which may be a problem if you're behind a strict firewall. You may instead use the clone url http://git.xonotic.org/xonotic/xonotic.git however using the git protocol directly is preferred for performance reasons.
+
 After that, you have a working checkout of the repository.
 
-h3. Getting write access
+Ubuntu Dependencies:
+<pre>
+sudo apt-get install build-essential xserver-xorg-dev x11proto-xf86dri-dev x11proto-xf86dga-dev x11proto-xf86vidmode-dev libxxf86dga-dev libxcb-xf86dri0-dev libxpm-dev libxxf86vm-dev libsdl1.2-dev libsdl-image1.2-dev libclalsadrv-dev libasound2-dev libxext-dev libsdl1.2debian-pulseaudio
+</pre>
+
+
+h2. Getting write access
 
 A condition for write (push) access is that you agree that any code or data you push will be licensed under the General Public License, version 2, with or without the "or any later version" clause. In case the directory the changes apply to contains a LICENSE or COPYING file indicating another license, your pushed code has to be dual licensed appropriately. Subdirectories currently having a dual license:
 * data/qcsrc/warpzonelib - dual licensed as "GPLv2 or later" or MIT license.
@@ -40,7 +54,7 @@ git config remote.origin.url ssh://xonotic@git.xonotic.org/xonotic.git
 
 After that, you can write to the reposiotry using the usual git commands (commit, push).
 
-h3. Working with the helper script "all"
+h2. Working with the helper script "all"
 
 To make working with the repo a little easier there's a little helper script (it's called all, as mentioned in above clone commands). It supports the following commands:
 
@@ -69,10 +83,10 @@ Lists all the branches known for all the respective repositories
 Compiles the game given that you have the required libs installed
 
 <pre>
-./all checkout
+./all checkout BRANCH
 </pre>
 
-Who knows?
+Switch to that branch in all repositories where its available
 
 <pre>
 ./all run xonotic
@@ -86,7 +100,7 @@ Starts the xonotic client
 
 Starts a xonotic dedicated server
 
-h3. Further git information
+h2. Further git information
 
 About tracking remote branches: