Development:GIT: Difference between revisions

From Adonthell
Jump to navigation Jump to search
m Development:CVS moved to Development:GIT: Adonthell is no longer kept in CVS ... we've moved to git
Updated with details about our new git repositories
Line 1: Line 1:
If you want to contribute code to Adonthell, you will have to get the latest version from [http://en.wikipedia.org/wiki/Concurrent_Versions_System CVS], the revision control system we're using. Information about accessing the repository can be found on our [http://savannah.nongnu.org/cvs/?group=adonthell Savannah Project page], but simple instructions are replicated below.
If you want to contribute code to Adonthell, you will have to get the latest version from [http://en.wikipedia.org/wiki/Git_(software) GIT], the revision control system we're using. Information about accessing the repositories can be found at [http://github.com/guides/home github.com], but simple instructions are replicated below.


Once you have acquired the source code and installed all [[Development:Dependency Matrix|dependencies]] you can go forward and [[Development:Compiling|build]] Adonthell.  
Once you have acquired the source code and installed all [[Development:Dependency Matrix|dependencies]] you can go forward and [[Development:Compiling|build]] Adonthell.  


== Adonthell CVS Modules ==
== Adonthell Git Repositories ==


There are a number of modules available in the repository. For developing on Adonthell you will most likely need:
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 [[Architecture:Contents|Adonthell Engine]]
* '''[http://github.com/ksterker/adonthell/tree/master adonthell]''' -- the source code for the [[Architecture:Contents|Adonthell Engine]]
* '''tools''' -- the source code for the accompanying [[Tools:Contents|Tools]]
* '''[http://github.com/ksterker/adonthell-tools/tree/master adonthell-tools]''' -- the source code for the accompanying [[Tools:Contents|Tools]]
* '''gfx''' -- the media created for official games
* '''[http://github.com/ksterker/wastesedge/tree/master wastesedge]''' -- the data and media files for the [[Quests:Waste's Edge|Waste's Edge]] demo game


Mainly of historical interest are:
Older parts of Adonthell are still kept in a CVS repository at [http://savannah.nongnu.org/cvs/?group=adonthell 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
* '''adonthell-0.3''' -- the source code to the v0.3.x branch of the Adonthell Engine
* '''wastesedge''' -- the data and media files for the [[Quests:Waste's Edge|Waste's Edge]] demo game
* '''wastesedge''' -- the data and media files for the v0.3.x branch of the [[Quests:Waste's Edge|Waste's Edge]] demo game
* '''gfx''' -- the media created for official games
* '''doc''' -- the LaTeX sources to project documentation now found [[Main_Page|here]]  
* '''doc''' -- the LaTeX sources to project documentation now found [[Main_Page|here]]  


== Anonymous CVS Access ==
== Anonymous Git Access ==
 
At the beginning you will have read-only access to our central git repositories. Once you have submitted some patches and [[Development:Join The Team|joined]] our team you will be granted [[Development:GIT#Developer Git Access|push access]].
 
To obtain a clone of the repository for any of the above [[Development:GIT#Adonthell Git Repositories|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.


At the beginning you will only have read access to our CVS repository. Once you have contributed some code and [[Development:Join The Team|joined]] our team you will be granted [[Development:CVS#Developer CVS Access|full access]].
== Developer Git Access ==


To obtain a working copy for any of the above [[Development:CVS#Adonthell CVS Modules|modules]], issue the following commands:
In order to gain push access to our repository, you'll have to be registered as a developer at [http://github.com/ github.com] and [[Development:Join The Team|become a member]] of Adonthell. Then you can get a working copy of the desired [[Development:GIT#Adonthell Git Repositories|repository]] with:


   cvs -z6 -d:pserver:anonymous@cvs.savannah.nongnu.org:/sources/adonthell co <module>
   git@github.com:ksterker/<repository>.git


This will create a folder called ''<module>'' under your current working directory. Inside that folder, run
To update your clone use


   cvs -z6 update -dP
   git pull origin master


from time to time to get the most recent version.
If you have added new files or made changes to existing files in your local repository:


== Developer CVS Access ==
  git status
  git add <files>
  git commit


In order to gain write access to our CVS, you'll have to be registered as a developer at [http://savannah.nongnu.org/ Savannah] and [[Development:Join The Team|become a member]] of Adonthell. Then you can get a working copy of the desired [[Development:CVS#Adonthell CVS Modules|module]] with:
Finally, push them to the central github repository:


   export CVS_RSH=ssh
   git push
  cvs -z6 -d:ext:<membername>@cvs.savannah.nongnu.org:/sources/adonthell co <module>


To update the working copy use
For more information on how to use Git you might want to refer to the [http://github.com/guides/git-cheat-sheet Git Cheat Sheet] or simply run


   export CVS_RSH=ssh
   git <command> --help
  cvs -z6 update -dP


For more information on how to use CVS you might want to refer to [http://cvsbook.red-bean.com/ Open Source Development with CVS] by Karl Fogel and Moshe Bar.


[[Category:Development]]
[[Category:Development]]

Revision as of 19:19, 8 June 2009

If you want to contribute code to Adonthell, you will have to get the latest version from 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:

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:

 [email protected]: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