Development:GIT

If you want to contribute code to Adonthell, you will have to get the latest version of Git, the revision control system we're using. Information about accessing the repositories can be found at github.com, but simple instructions are replicated below.

Once you have acquired the source code and installed all dependencies you can go forward and build Adonthell.

Adonthell Git Repositories

There are a number of repositories to keep things organized. For developing on Adonthell you will most likely need:

• adonthell -- the source code for the Adonthell Engine
• adonthell-tools -- the source code for the accompanying Tools
• wastesedge -- the data and media files for the Waste's Edge demo game

Older parts of Adonthell are still kept in a CVS repository at Savannah. See there for instructions on how to access them.

• adonthell-0.3 -- the source code to the v0.3.x branch of the Adonthell Engine
• wastesedge -- the data and media files for the v0.3.x branch of the Waste's Edge demo game
• gfx -- the media created for official games
• doc -- the LaTeX sources to project documentation now found here

Anonymous Git Access

At the beginning you will have read-only access to our central git repositories. Once you have submitted some patches and joined our team you will be granted push access.

To obtain a clone of the repository for any of the above repositories, issue the following command:

 git clone git://github.com/ksterker/<repository>.git

This will create a folder called <repository> under your current working directory. Inside that folder, run

 git pull origin master

from time to time to update your clone to the most recent version.

Developer Git Access

In order to gain push access to our repository, you'll have to be registered as a developer at github.com and become a member of Adonthell. Then you can get a working copy of the desired repository with:

 git clone git@github.com:ksterker/<repository>.git

To update your clone use

 git pull origin master

If you have added new files or made changes to existing files in your local repository:

 git status
 git add <files>
 git commit

Finally, push them to the central github repository:

 git push

For more information on how to use Git you might want to refer to the Git Cheat Sheet or simply run

 git <command> --help