Developer Setup

Build Mythling from GitHub-hosted source, and run this local build on your device.

###IDE Setup

1. Install Eclipse with the Android ADT Plugin.

   • The Mythling project.properties file specifies target=android-19, so to compile you'll need to install Android 4.4.2 (which can be done through the Android SDK Manager in Eclipse).

2. Get the source code.

   • Copy the Git repository URL for the Mythling master branch into the clipboard:
     https://github.com/oakesville/mythling.git
   • Open the Git Repositories view in Eclipse (Window > Show View > Other > Git > Git Repositories).
   • Right-click in Git Repositories view and select "Paste Repository Path or URI".
   • Click through the Git Clone wizard, accepting the defaults unless you're a contributor and you want non-anonymous access, or the local repository path is not correct.

##Build and Run

1. Build the project.

   • To make getting started easy, we've committed the Eclipse .project and .classpath files. There's nothing environment-specific in these files so you shouldn't need to change them. By default Eclipse hides these files in Package Explorer view. You can display them by disabling the ".* resources" filter which is accessed via the Package Explorer dropmenu (the down-facing triangle icon in Package Explorer's toolbar).
   • If you've got Eclipse autobuild enabled, the project will have already been built; otherwise select Project > Build All from the menu or type ctrl-b. In case Eclipse complains about the res directory being missing, you may need to select Project > Clean before building.

2. Run in debug mode on your device.

   • Uninstall Mythling if you've installed it through the Play Store. Note: you'll lose your preference settings and they'll need to be re-entered.
   • Enable USB Debugging through the Android Settings app. This option is located under Developer Options.
   • Connect your device to a USB port on the PC where you're running Eclipse. (Some Samsung devices require their Kies PC software for USB connectivity. Other manufacturers may require their own specialized installations.)
   • In Eclipse, right click on the mythling project in Package Explorer view and select Debug As > Android Application. Find and select your device under "Choose a running device". (If you don't have a device or want to test a different profile you can create an Android Virtual Device to run through the emulator). Click OK.
   • ADT will install the Mythling APK on your device and you'll be able to step through the code and evaluate variables. A good place to start with a breakpoint is in MainActivity.refresh().