Difference between revisions of "GetTheCode"

From Sirikata Wiki
Jump to: navigation, search
(Add note about linux git-core package.)
Line 27: Line 27:
 
In this case you will also be able to push your results back to our repository.
 
In this case you will also be able to push your results back to our repository.
  
You should now have all the code in a directory called <tt>sirikata</tt>.  Now you probably want to [[BuildTheCode|build it]].
+
You should now have all the code in a directory called <tt>sirikata</tt>.  At the moment we require that the full path to sirikata has no spaces in any folder names. Now you probably want to [[BuildTheCode|build it]].

Revision as of 06:53, 15 August 2009

Browsing the Code

Our project is hosted in a GitHub repository. You can browse the source online by visiting the Sirikata project page.

Getting the Full Tree

Get git

We use git for source code version control. First be sure that you have git installed. You can find packaged and source downloads for all platforms here. On Windows you most likely want to install the msysgit variant. On Linux you can likely use a package directly from your distribution. For example, on Ubuntu, the following will install the basic git tools:

 sudo apt-get install git-core

If you want to develop Sirikata you should familiarize yourself with git. Git's documentation page provides a lot of good starting points.

Check out the code

If you're checking out the code anonymously, use the public clone url. Move to where you want to check out the code and issue the command

 git clone git://github.com/sirikata/sirikata.git [dest_directory]
 cd dest_directory   # will be sirikata if dest_directory was not provided
 git submodule init
 git submodule update

If you are a developer, you can use the secure clone URL. Once you have given GitHub your public key for authentication, you can issue the command.

 git clone git@github.com:sirikata/sirikata.git [dest_directory]
 cd dest_directory   # will be sirikata if dest_directory was not provided
 git submodule init
 git submodule update

In this case you will also be able to push your results back to our repository.

You should now have all the code in a directory called sirikata. At the moment we require that the full path to sirikata has no spaces in any folder names. Now you probably want to build it.