Skip to content

Getting Started

Trevor Decker edited this page Sep 2, 2015 · 35 revisions

Hello and welcome to robobuggy! We are super glad to have you join our team this page is meant to be a jumping off point about how to get up to speed on the project!

Getting connected

Tools we use

Mechanical

Electrical

Software

Terminal

 TODO

Getting started with GIT

Git is version control software that allows for users to track changes that they or others make. It also allows for multiple people to contribute to software development at the same time.

to get a copy of the repo you need to clone it do this by opening a terminal window and navigating to where you want to store the robobuggy software then type 'git clone https://github.com/CMU-Robotics-Club/RoboBuggy.git'

You make changes to a file, you stage the file for a commit by typing `git add '. You can do this for several files. Once you are at a reasonable point to save your work you can commit your changes by typing 'git commit' Enter a description of what was in the commit in the text prompt that appears. Then you can get other peoples changes by typing 'git pull'. You can share your changes by typing 'git push'

You should learn at a high level how git works by playing and completing: http://pcottle.github.io/learnGitBranching/ It can be frustrating at times, but it is worth it to complete

If you ever have a question about git try using google, http://git-scm.com/ or ask one of the more senior members. When in doubt do not use -f before asking someone It can really mess things up.

Getting started with eclipse

 TODO

What is Travis CI

TODO

What is a MakeFile

TODO

What programing languages do you use

You can use pretty much what ever you want. We mostly use Java and C, with a little C++, python, bash scripts and Matlab

System Overview

TODO

Useful links

TODO