Getting the Source

Step by step instructions for getting the source, making an initial build and running it on the emulator

To fork the source code: go to the project source code. On the top right you will find a clickable button named "fork". This will create a forked repository under your GitHub account and it will say: "This branch is even with cgeo:master". The web page you are looking at renders a view of your forked repository. You will see a green button labeled "Code". Click that button, copy the link that is shown to the clip board. Now go to your development system and type:

>git clone <the_link_from_the_step_above)

To check everything worked as expected:

>git remote -v

  origin	https://github.com/<your_userid>/cgeo.git (fetch)
  origin	https://github.com/<your_userid>/cgeo.git (push)

Specify a new remote upstream repository that will be synced with the fork:

>git remote add upstream https://github.com/cgeo/cgeo.git

Check the response:

>git remote -v

  origin	https://github.com/<your_userid>/cgeo.git (fetch)
  origin	https://github.com/<your_userid>/cgeo.git (push)
  upstream	https://github.com/cgeo/cgeo.git (fetch)
  upstream	https://github.com/cgeo/cgeo.git (push)

As a next step, setup your API keys, as described here under "API Key Installation". Once this is done, you can do your first Gradle Build in Android Studio:

Build -> Make Project

Once that completes, hopefully with 0 errors, you can configure an emulator device and launch the application in the emulator.

That completes the step by step instructions on how to get the source.