Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 96 lines (54 sloc) 4.633 kB
19ae10b @timsu Modernized our README. man, it's old.
timsu authored
1 [Astrid](http://www.astrid.com/) - Task Management Done Right
e1861b8 @timsu Deleted unuesd file, updated README message
timsu authored
2 ================================
97f9ccd @timsu Added a readme
timsu authored
3 Astrid strives to be a simple and effective organization tool for Google Android phones. It comes with features like reminders, tagging, widgets, and integration with online synchronization services.
4
e1861b8 @timsu Deleted unuesd file, updated README message
timsu authored
5 Interested in using Astrid? Search "astrid" in Android Market. Look for the smiling pink squid!
6
7 If you would like to help out with the Astrid project, you're in the right place.
8
e8e4dfe @timsu Cleaned up readme formatting
timsu authored
9 Getting Started With Development
e1861b8 @timsu Deleted unuesd file, updated README message
timsu authored
10 ---------------
11
a24f320 @timsu COLLABORATORS - READ THIS COMMIT!
timsu authored
12 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/)).
462723b @timsu More formatting tweaks to README. github fail?
timsu authored
13
e1861b8 @timsu Deleted unuesd file, updated README message
timsu authored
14 2. Install the following:
8f974d1 @timsu Again! more README
timsu authored
15 *[git](http://git.or.cz/)*
16 *[Eclipse](http://eclipse.org)* (preferred: Eclipse IDE for Java Developers)
19ae10b @timsu Modernized our README. man, it's old.
timsu authored
17 *[Android SDK](http://developer.android.com/sdk/index.html)* (Recommended SDK Platform: Android 4.0 Google APIs)
18 *[ADT Plugin for Eclipse](http://developer.android.com/sdk/eclipse-adt.html)*
462723b @timsu More formatting tweaks to README. github fail?
timsu authored
19
a947963 @JoshuaGross Fixed build process to work with Eclipse
JoshuaGross authored
20 3. Use **git** to clone your forked repositories
34e18ec @jonparis Added contributors workflow to the readme.
jonparis authored
21
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
22 `git clone git@github.com:yourgithubid/astrid.git`
34e18ec @jonparis Added contributors workflow to the readme.
jonparis authored
23
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
24 (see Github's instructions if you need help). Follow the [Github Line Ending Help](http://help.github.com/dealing-with-lineendings/)
462723b @timsu More formatting tweaks to README. github fail?
timsu authored
25
945e2a7 @timsu Fixed instructions
timsu authored
26 4. Open up **eclipse** and import the *astrid*, *astridApi*, *astrid-tests*, *facebook*, and *GreenDroid* projects.
4bd1005 @JoshuaGross Updated readme to document more of initial contributor workflow
JoshuaGross authored
27
28 5. In Eclipse preferences -> Android build settings, set the SDK location (you installed it in step 2). At this point, there should be no compilation errors. If there are, you might have to **refresh** and **clean** the projects a few times from within **eclipse**
65f3f04 @jonparis Updated Readme with input from Arne. (astrid original - named upstre…
jonparis authored
29
30 *from Eclipse: project-menu -> clean -> select projects -> check "start a build immediately" if "automatic build" is not enabled*
462723b @timsu More formatting tweaks to README. github fail?
timsu authored
31
4bd1005 @JoshuaGross Updated readme to document more of initial contributor workflow
JoshuaGross authored
32 6. Launch the *astrid* project as an **Android Application**, or the *astrid-tests* project as an **Android JUnit Test Suite**.
462723b @timsu More formatting tweaks to README. github fail?
timsu authored
33
4bd1005 @JoshuaGross Updated readme to document more of initial contributor workflow
JoshuaGross authored
34 7. Join the [Astrid Power-Users List](http://groups.google.com/group/astrid-power).
462723b @timsu More formatting tweaks to README. github fail?
timsu authored
35
4bd1005 @JoshuaGross Updated readme to document more of initial contributor workflow
JoshuaGross authored
36 8. Check out the [Product Roadmap](http://wiki.github.com/todoroo/astrid/) and [Issues](http://github.com/todoroo/astrid/issues), and look for something you'd want to tackle.
e1861b8 @timsu Deleted unuesd file, updated README message
timsu authored
37
4bd1005 @JoshuaGross Updated readme to document more of initial contributor workflow
JoshuaGross authored
38 9. Read the following contributor and debugging workflow and help make Astrid better!
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
39
4bd1005 @JoshuaGross Updated readme to document more of initial contributor workflow
JoshuaGross authored
40 10. Sign a [Contributors License Agreement](https://github.com/downloads/todoroo/astrid/Contributors%20Licensing%20Agreement.pdf) and send it to astrid AT todoroo.com
a760d84 @jonparis Added CLA step to readme
jonparis authored
41
f91984f @JoshuaGross Updated README to help kick-start developers debugging/testing, and c…
JoshuaGross authored
42 Testing on a device - Debugging
c42dd42 @JoshuaGross Show sync option in menu if no sync accounts are set up, then prompt …
JoshuaGross authored
43 ---------------
f91984f @JoshuaGross Updated README to help kick-start developers debugging/testing, and c…
JoshuaGross authored
44 How to debug/test on a USB device: (JoshuaGross Jan 14, 2011)
4958a29 @JoshuaGross Updating readme to warn of JUnit jankiness
JoshuaGross authored
45
f91984f @JoshuaGross Updated README to help kick-start developers debugging/testing, and c…
JoshuaGross authored
46 1. Plug in your device and make sure you can see it by running `adb devices`
4958a29 @JoshuaGross Updating readme to warn of JUnit jankiness
JoshuaGross authored
47
f91984f @JoshuaGross Updated README to help kick-start developers debugging/testing, and c…
JoshuaGross authored
48 2. If you cannot see the device, or want to restart debugging, do:
4958a29 @JoshuaGross Updating readme to warn of JUnit jankiness
JoshuaGross authored
49
50 `adb kill-server`
51
52 `adb usb`
53
54 `adb devices` (make sure your device is listed)
55
56 `adb uninstall com.todoroo.astrid.tests` (you should see "Failure" if this was uninstalled already)
57
58 `adb uninstall com.todoroo.astrid` (you should see "Failure" if this was uninstalled already)
59
60 3. If you have not already, set up Run configurations in Eclipse; either under the "Run" or "Debug" menus. To test the application, set up "Android Application". To run JUnit tests, set up "Android JUnit Tests". Settings should autofill for you, you should be able to open a new configuration and run it. If you run it in debug mode, see #2 above for getting adb to work in case it is finicky.
61
62 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.
c42dd42 @JoshuaGross Show sync option in menu if no sync accounts are set up, then prompt …
JoshuaGross authored
63
a24f320 @timsu COLLABORATORS - READ THIS COMMIT!
timsu authored
64 5. Make sure to commit changes both to the "astrid" project while developing.
1a8f646 @JoshuaGross Fixed off-by-one-second task filtering error
JoshuaGross authored
65
a760d84 @jonparis Added CLA step to readme
jonparis authored
66 Contributors workflow
bec8998 @jonparis additional readme formatting
jonparis authored
67 ---------------
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
68
bec8998 @jonparis additional readme formatting
jonparis authored
69 **Setup:**
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
70
a24f320 @timsu COLLABORATORS - READ THIS COMMIT!
timsu authored
71 `git clone git@github.com:your-github-id/astrid.git` (your-github-id should obviously be replaced)
3880353 @jonparis formatting of readme
jonparis authored
72
45e927e @jonparis Edited README.md via GitHub
jonparis authored
73 `git remote add upstream git@github.com:todoroo/astrid.git`
34e18ec @jonparis Added contributors workflow to the readme.
jonparis authored
74
bec8998 @jonparis additional readme formatting
jonparis authored
75 **Working on new features/fixes:**
34e18ec @jonparis Added contributors workflow to the readme.
jonparis authored
76
945e2a7 @timsu Fixed instructions
timsu authored
77 `git checkout -b my-new-features upstream/master`
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
78
79 work, work, work!
80
81 `git commit` (a separate commit for each bug fix, feature change, style or copy edit please!)
82
65f3f04 @jonparis Updated Readme with input from Arne. (astrid original - named upstre…
jonparis authored
83 `git fetch upstream`
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
84
65f3f04 @jonparis Updated Readme with input from Arne. (astrid original - named upstre…
jonparis authored
85 `git rebase -i upstream/master` (i like to rebase -i to verify what i'm committing and squish small commits)
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
86
945e2a7 @timsu Fixed instructions
timsu authored
87 `git push origin HEAD`
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
88
34e18ec @jonparis Added contributors workflow to the readme.
jonparis authored
89 then go to github and submit a pull request!
0ca9cb6 @jonparis Updated the contributor workflow in the readme
jonparis authored
90
945e2a7 @timsu Fixed instructions
timsu authored
91 For further information, read [Tim's Collaborator Guide](http://www.betaful.com/2011/04/git-for-ongoing-collaboration/).
92
e1861b8 @timsu Deleted unuesd file, updated README message
timsu authored
93 Contact
94 -------
19ae10b @timsu Modernized our README. man, it's old.
timsu authored
95 For general support requests, use [Astrid's feedback page](http://astrid.com/feedback). For development questions, contact [timsu](http://github.com/timsu) via e-mail.
Something went wrong with that request. Please try again.