Difference between revisions of "Getting VDrift"

From VDrift
Jump to: navigation, search
(revised the introduction)
(Source Package: Simplify)
Line 23: Line 23:
 
=== Source Package ===
 
=== Source Package ===
  
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift Linux source package. All the files in the package are in a directory called vdrift-'''version'''-src where '''version''' is something like 2009-06-15.
+
[http://sourceforge.net/project/showfiles.php?group_id=137283 Download] the latest VDrift source package and unpack the archive.
 
+
  tar jxvf vdrift-yyyy-mm-dd-src.tar.bz2
Unpack the archive.
 
 
 
  tar jxvf vdrift-2009-06-15-src.tar.bz2
 
 
 
==== Enter directory ====
 
 
 
Now change directories into the location of your newly created VDrift source tree.
 
cd vdrift-2009-06-15
 
  
 
=== Windows ===
 
=== Windows ===

Revision as of 15:10, 8 February 2012

Getting VDrift should follow getting the prerequisites. See Software requirements.

Getting VDrift enables VDrift to be build. See Compiling VDrift.

Getting VDrift consists of getting its two major parts, the source code and the data. Both are described below.

Latest Release

VDrift releases are available on SourceForge. It is recommended that users download the very latest release for their operating system.

Version Numbering

Each release of VDrift has a version number corresponding to the date of release, in the YYYY-MM-DD format. The latest release will be have the version number closest to the current date.

Operating Systems

Currently, downloadable releases are usually provided for Linux, Mac OS X, and Windows. The installer package for a given operating system will be marked as such in the SourceForge download system.

Linux

You can get the code from a source package for a particular version, or you can get the development version.

Source Package

Download the latest VDrift source package and unpack the archive.

tar jxvf vdrift-yyyy-mm-dd-src.tar.bz2

Windows

Mac OS

Development Version

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 copy of the source code and your platform's dependencies.

Linux/Unix

Install a git client (eg. 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:

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 to which you want to download the VDrift source code. 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 source code will be downloaded. Then do the same, but with the URL git://github.com/VDrift/vdrift-win.git and make sure that it downloads in a /vdrift-win directory in the main vdrift directory. Next, check out the data.

Mac OS X

First you will need to obtain a git client (eg. GitHub for Mac). Once you have a working Git client open a terminal and navigate to where you wish to download the VDrift source code. Then run the following code:

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

to download the lastest source code to the subfolder vdrift. Then navigate to the vdrift folder:

cd vdrift

and download the mac dependencies into the subfolder vdrift-mac:

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

Finally check out the data.

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

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.