|
|
@@ -1,4 +1,32 @@
|
|
|
-astroid-web
|
|
|
-===========
|
|
|
+Astroid - Task Management Done Right
|
|
|
+================================
|
|
|
|
|
|
-Astroid: Fork of Astrid, Android's #1 Task Management Application
|
|
|
+Astroid strives to be a simple and effective organization tool for everyone. It
|
|
|
+will soon come with features like reminders, tagging, widgets, and integration
|
|
|
+with online synchronization services.
|
|
|
+
|
|
|
+Interested in using Astroid? Git clone to self-host, cloud hosting is coming
|
|
|
+soon!
|
|
|
+
|
|
|
+If you would like to help out with the Astroid project, you're in the right
|
|
|
+place.
|
|
|
+
|
|
|
+Getting Started With Development
|
|
|
+---------------
|
|
|
+
|
|
|
+1. Create your own fork of Astroid by clicking on Github's *Fork* button above
|
|
|
+(you may have to log in first - [github help](http://help.github.com/forking/)).
|
|
|
+
|
|
|
+2. Install *[git](http://git-scm.com/)* on your local machine
|
|
|
+
|
|
|
+3. Use **git** to clone your forked repository
|
|
|
+
|
|
|
+4. Viola! You can start making edits and self-host for testing.
|
|
|
+
|
|
|
+5. Submit a pull request once your edits are ready to be merged into the main
|
|
|
+project.
|
|
|
+
|
|
|
+License
|
|
|
+---------------
|
|
|
+
|
|
|
+Astroid is licensed under the GNU Affero GPL License version 3.
|
