Skip to content
Dan Royer edited this page Oct 7, 2016 · 37 revisions

Everybody not a developer or tester

Please visit https://www.marginallyclever.com/product-category/buy-a-robot/ and choose your version of Makelangelo for more information.

Developers & Testers

How to get started hacking on the Makelangelo project

Get the (free) tools we use

(Some people have also used IntelliJ IDEA instead of Eclipse)

Quick start

git clone https://github.com/MarginallyClever/Makelangelo.git --branch dev ~/Makelangelo
the above snippet is all one command, GitHub/textile formatting is splitting it onto two lines.
cd ~/Makelangelo
script/bootstrap

The previous command line snippets will clone the latest code to your home directory and then run the bootstrap script that sets up the rest of the project (downloads an Apache Maven wrapper, downloads project dependencies and installs the project into your local Maven repository).

IDE Specific Steps

Eclipse
  1. Start Eclipse, then choose File > Import > Maven > Existing Maven Projects > Select root directory > Browse > find where you cloned github/Makelangelo > Ok > uncheck "Copy projects into workspace > Finish
  2. Choose Package Explorer > Right click on Makelangelo > Maven > Update project. Wait while it downloads and configures dependencies
  3. Select Right click on Makelangelo > Run As > Java Application.

Makelangelo should run! Make changes to the code and run again to see the effect.

IntelliJ

Instructions for IntelliJ have not yet been written.

Now we’re ready to run!

Run

Click the green bug or Run > Debug from the menus at the top.

You will be asked what type to run. Choose “Java application”.

The app should begin.

When you are not running the app you can make changes to the code and then press debug to see the effect of your new work. Sometimes you can make changes while the program is running!

Exporting a jar file

You shouldn’t need to do this, but here: See Instructions for exporting a jar file for release.

Further reading for exporting a jar in Maven

Contributing

When you are ready to share you changes, send us a pull request.

Don’t forget to check our issues list to see the roadmap and our list of current challenges.

Help

Please visit Makelangelo support forums

Thanks

Thank you to Chris Mills for contributing these instructions.

Clone this wiki locally