Skip to content
ptroja edited this page Sep 14, 2010 · 14 revisions

Git install

The first step to set up MRROC++ source code for work with Git is to download a Git software.

  • If you are using recent Linux distribution, just ask your package manager to do this job.
  • For Windows there are some GUI based Gits out there, but this tutorial will only explain howto work with command line tools. Probably the right one is the msysGit (you have to download a Git-x.x.x.x-*.exe file)
  • If you are brave enough to use Git under your Eclipse editor, please check this tutorial.

Get a GitHub account

As long as GitHub is the best code hosting service in the world – we will use it.

  • Just try to login and follow instructions to get a free Open Source plan account.
  • Next you have to setup a SSH keys to authenticate against GitHub service. Simply follow these steps.

Git config

In order introduce yourself to Git, as well as to other developers, just do:

git config --global user.name "Tekkub"
git config --global user.email "[email protected]"

To link your personality with Github account do:

git config --global github.user Your_Github_Username

To enable color console output:

git config --global color.diff auto
git config --global color.status auto
git config --global color.branch auto

To use visual merge tool, Meld:

git config --global merge.tool meld

Become a developer

Just visit the “mainstream” MRROC++ project and press a fork button to create your own development branch. Now it is time to actually pull down a code. Follow steps “Forking a project” and “Setting up” screenshots from here. Just to compare:

SVN Git
svn checkout git clone
svn up git pull

Start your work!

Hack, hack, hack… In the meantime you should read any Git tutorial, which will get you familiar with commit, add, status commands (these are the basic one) and a lots of more (those you learn later).
GitHub is willing to help you with a list of tutorials, screencasts and an every day commands list.

Finally open the same page as previously and this time read the “Pushing your changes” section. Please fell the difference:

SVN Git
svn commit git commit -a (this one works locally)
svn commit git push (and this one actually pushes a bunch of commits to GitHub)

When you wish to share your work

Now, as your really big improvement is completed, please share it with the rest of community. It is as easy as 1-2-3 (which I mean a three first steps from this page). All the remaining work will be done by a main project developer after making sure, that your code is good enough to fill the high standards of robotic software framework.