Difference between revisions of "Working with the development version"

From VDrift
Jump to: navigation, search
m
(Various improvements, including add information about working with subversion)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
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.
+
This page describes some of the most common commands used when working with VDrift's source code. It assumes you have followed the instructions in the [[Getting the development version#Cloning/Checking out|Cloning/Checking out]] section of [[Getting the development version]].
  
==Browsing the repositories==
+
See this documentation for more up to date and complete information: http://help.github.com/
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==
+
==Updating==
If you want to do much work on VDrift you'll need to check out an entire copy of the development tree.
+
===Git===
 +
To update the Git repositories, execute the following command in the root folder of the repository (i.e. '''vdrift''', '''vdrift/vdrift-win''' or '''vdrift/vdrift-mac'''):
 +
git pull git://github.com/VDrift/vdrift.git
  
===Linux/Unix===
+
===Subversion===
Install a git client (eg. [http://git-scm.com/ Git]). 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:
+
To update the data, run the following command while in '''vdrift/data'''
git clone git://github.com/VDrift/vdrift.git vdrift
+
svn update
It will download the current development version in the subfolder vdrift. Next, [[Getting_the_development_version#Checking_out_the_data|check out the data]].
 
  
===Windows===
+
==Making your own changes==
The best solution for Windows is to download [http://code.google.com/p/msysgit/ MSysGit]. After installing it, open Windows Explorer and go to the directory to which 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, [[Getting_the_development_version#Checking_out_the_data|check out the data]].
+
===Git===
 
+
These instructions also apply for the dependencies - just change the file paths and URLs.  
===Mac OS X===
+
====Forking====
This is the same as working with [[Getting_the_development_version#Linux/Unix|Linux/Unix]] however you will need to obtain a git client (eg. [http://mac.github.com/ GitHub for Mac]).
+
If you want to make your own changes to improve VDrift, the easiest way is to fork the main VDrift repository on [https://github.com/VDrift/vdrift/ GitHub]. Just click the button near the top right of the page. You will need a free [http://github.com GitHub] account. Then clone your new repo onto your computer:
Once you have a working SVN client see the [[Getting_the_development_version#Linux/Unix|Linux/Unix]] instructions.
 
 
 
==Checking out the data==
 
The data set is currently only available from the SourceForge SVN (https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data). It needs to be checked out in a ''/data'' directory in the main vdrift directory. If you are using a command-line SVN client and have the VDrift repository checked out in a directory called ''/home/user/vdrift'', you would do this:
 
cd /home/user/vdrift
 
svn co https://vdrift.svn.sourceforge.net/svnroot/vdrift/vdrift-data data
 
 
 
==Working with the repository==
 
See this documentation for more info: http://help.github.com/
 
 
 
===Making your own changes===
 
If you want to make your own changes to improve VDrift, the easiest way is to fork the main VDrift repo on GitHub (https://github.com/VDrift/vdrift/). Just click the button near the top right of the page. You will need a free GitHub account.
 
Then clone your new repo onto your computer:
 
 
  git clone git@github.com:''username''/vdrift.git
 
  git clone git@github.com:''username''/vdrift.git
 
And link this to the original VDrift repo:
 
And link this to the original VDrift repo:
  git remote add upstream git://github.com/octocat/Spoon-Knife.git
+
cd vdrift
git fetch upstream
+
  git remote add upstream git://github.com/VDrift/vdrift.git
 
 
===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.
 
If you have made some changes, use the following to prevent these being lost:
 
 
  git fetch upstream
 
  git fetch upstream
git merge upstream/master
 
  
===Uploading changes===
+
====Uploading changes====
 
To upload any changes you've made, first add the files to the commit:
 
To upload any changes you've made, first add the files to the commit:
 
  git add ''filename''
 
  git add ''filename''
Line 51: Line 31:
 
  git push origin master
 
  git push origin master
  
===Checking in changes===
+
====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/
 
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/
  
 +
===Subversion===
 +
You will need to ask a VDrift developer in the [http://vdrift.net/Forum/index.php forums] for Subversion access in order to commit to the repository. You will need a free [http://sourceforge.net Sourceforge] account. You can then add any new files or folders you've created:
 +
svn add ''filename''
 +
And then commit the changes:
 +
svn commit -m "Commit message"
 +
If you don't want to do this, you can create a diff which you can post in the [http://vdrift.net/Forum/index.php forums]:
 +
svn diff
  
Thank you for helping make VDrift better for everyone!
+
====Thank you for helping make VDrift better for everyone!====
  
 
[[Category:Development]]
 
[[Category:Development]]
[[Category:Review]]
 
[[Category:Operating Systems:Linux]]
 
[[Category:Operating Systems:FreeBSD]]
 
[[Category:Operating Systems:Windows]]
 
[[Category:Operating Systems:Mac OS X]]
 

Latest revision as of 12:39, 26 August 2012

This page describes some of the most common commands used when working with VDrift's source code. It assumes you have followed the instructions in the Cloning/Checking out section of Getting the development version.

See this documentation for more up to date and complete information: http://help.github.com/

Updating

Git

To update the Git repositories, execute the following command in the root folder of the repository (i.e. vdrift, vdrift/vdrift-win or vdrift/vdrift-mac):

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

Subversion

To update the data, run the following command while in vdrift/data

svn update

Making your own changes

Git

These instructions also apply for the dependencies - just change the file paths and URLs.

Forking

If you want to make your own changes to improve VDrift, the easiest way is to fork the main VDrift repository on GitHub. Just click the button near the top right of the page. You will need a free GitHub account. Then clone your new repo onto your computer:

git clone git@github.com:username/vdrift.git

And link this to the original VDrift repo:

cd vdrift
git remote add upstream git://github.com/VDrift/vdrift.git
git fetch upstream

Uploading changes

To upload any changes you've made, first add the files to the commit:

git add filename

Then do the commit:

git commit -m 'Commit message'

And finally send this to GitHub:

git push origin master

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/

Subversion

You will need to ask a VDrift developer in the forums for Subversion access in order to commit to the repository. You will need a free Sourceforge account. You can then add any new files or folders you've created:

svn add filename

And then commit the changes:

svn commit -m "Commit message"

If you don't want to do this, you can create a diff which you can post in the forums:

svn diff

Thank you for helping make VDrift better for everyone!