From a24f3200f62acf428453e1cb74cb3d9a34f502c6 Mon Sep 17 00:00:00 2001 From: Tim Su Date: Tue, 18 Jan 2011 15:07:29 -0800 Subject: [PATCH] COLLABORATORS - READ THIS COMMIT! --------------------------------- Astrid's library projects (astridApi and GreenDroid) have moved to become part of this repository. This will make your life easier, but if you have already imported astridApi, you will have to delete this project from Eclipse and re-import it from its new location within the api/ folder of this repository. Thanks! --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index cce7e4e7d..c7a9ee766 100644 --- a/README.md +++ b/README.md @@ -9,22 +9,21 @@ If you would like to help out with the Astrid project, you're in the right place Getting Started With Development --------------- -1. Create your own fork of Astrid and astridApi by clicking on Github's *Fork* button above, and the same button in the [astridApi project](https://github.com/todoroo/astridApi) (you may have to log in first - [github help](http://help.github.com/forking/)). +1. Create your own fork of Astrid by clicking on Github's *Fork* button above (you may have to log in first - [github help](http://help.github.com/forking/)). 2. Install the following: • *[git](http://git.or.cz/)* • *[Eclipse](http://eclipse.org)* (preferred: Eclipse IDE for Java Developers) - • *[Android SDK](http://developer.android.com/sdk/index.html)* - • *[ADT Plugin for Eclipse](http://developer.android.com/sdk/eclipse-adt.html)* + • *[Android SDK](http://developer.android.com/sdk/index.html)* (last tested with SDK v8) + • *[ADT Plugin for Eclipse](http://developer.android.com/sdk/eclipse-adt.html)* (last tested with ADT v8.0) 3. Use **git** to clone your forked repositories `git clone git@github.com:yourgithubid/astrid.git` -`git clone git@github.com:yourgithubid/astridApi.git` (see Github's instructions if you need help). Follow the [Github Line Ending Help](http://help.github.com/dealing-with-lineendings/) -4. Open up **eclipse** and import the *astrid*, *astridApi*, and *astrid-tests* projects. There should be no compilation errors. If there are, check the Android page of Eclipse Project Properties to verify the astridApi project was found. You might have to **clean** the projects from within **eclipse** +4. Open up **eclipse** and import the *astrid*, *astridApi*, *astrid-tests*, and *GreenDroid* projects. There should be no compilation errors. If there are, you might have to **refresh** and **clean** the projects a few times from within **eclipse** *from Eclipse: project-menu -> clean -> select projects -> check "start a build immediately" if "automatic build" is not enabled* @@ -60,21 +59,17 @@ How to debug/test on a USB device: (JoshuaGross Jan 14, 2011) 4. When running unit tests: make sure to *close all JUnit windows* before running tests. JUnit/Eclipse/Android work together in a very, very janky way. You may get incorrect results if you do not close the window out before running tests. You have been warned. -5. Make sure to commit changes both to the "astrid" project and the "astridApi" project while developing. +5. Make sure to commit changes both to the "astrid" project while developing. Contributors workflow --------------- **Setup:** -`git clone git@github.com:yourgithubid/astrid.git` - -`git clone git@github.com:yourgithub/astridApi.git` +`git clone git@github.com:your-github-id/astrid.git` (your-github-id should obviously be replaced) `git remote add upstream git://github.com/todoroo/astrid.git` -`git remote add upstream git://github.com/todoroo/astridApi.git` - **Working on new features/fixes:** `git checkout -b my-new-features`