Working with the development version

From VDrift
Revision as of 10:58, 3 July 2011 by Venzon (talk | contribs)
Jump to: navigation, search

VDrift's code is kept in a Git repository on GitHub. To get the development version, you must "check out" the code from this repository.

Browsing the repositories

VDrift's source on the GitHub web site is at https://github.com/VDrift/vdrift/. Here you may browse the VDrift repositories and even download single files. This is very useful for examining changes between different revisions, in a user-friendly manner.

Checking out the code

If you want to do much work on VDrift you'll need to check out an entire copy of the development tree.

Linux/Unix

Install a git (Git) client. If you are using a Linux distribution you can search for it in the package manager. When you have installed it you need to open a terminal and run the following code: 

git clone git://github.com/VDrift/vdrift.git vdrift

It will download the current development version in the subfolder vdrift. Next, check out the data.

Windows

The best solution for Windows is to download MSysGit. After installing it, open Windows explorer and go to the directory where you want to download the VDrift development version. Right-click and click Git GUI Here. Select Open Existing Repository. In the next screen you need to fill in the URL of the repository which is git://github.com/VDrift/vdrift.git. Simply click OK, and the development version will be downloaded. Next, check out the data.

Mac OS X

This is the same as working with Linux/Unix however you will need to obtain a git client. Once you have a working SVN client see the Linux/Unix instructions.

Checking out the data

The data set is currently only available from the SourceForge SVN. Get it from https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data to the vdrift/data from svn.vdrift.net. If you are using a command-line SVN client and have the VDrift repository checked out in a directory called /home/user/code, you would do this: 

cd /home/user/code
svn co https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data data

If you are using the Tortoise SVN client, see the documentation on the Tortoise SVN website for more information on how to check out a repository.

Working with the repository

Updating

Once the reposotory has been checked out, it can be updated without downloading the entire thing again. For command line git, use the command 

git pull

to check for updates and apply them.

Checking in changes

You can request a VDrift developer to incorporate your changes by initiating a GitHub pull request. See this documentation for more info: http://help.github.com/send-pull-requests/

Adding and removing files

Every file you introduce to the checkout on your computer is not automatically added to the repository. First you must add it: 

git add filename

Where filename is the file you wish to add. Similarly you may remove files that are no longer needed with git rm filename.

Retrieved from "http://wiki.vdrift.net/index.php?title=Working_with_the_development_version&oldid=1091"