aboutsummaryrefslogtreecommitdiffstats
path: root/README.mkdn
diff options
context:
space:
mode:
authorSteve Kondik <shade@chemlab.org>2010-12-21 23:29:15 -0500
committerSteve Kondik <shade@chemlab.org>2010-12-21 23:29:15 -0500
commit426f1a69770f515a9d4e6df42e6f397a05e94d34 (patch)
treea9d0fb9b2df7220f41ae12fe3157b246873880c8 /README.mkdn
parent533c5bad16e48871a204de7b19e2ed4c6e978a10 (diff)
downloadmanifest-426f1a69770f515a9d4e6df42e6f397a05e94d34.tar.gz
manifest-426f1a69770f515a9d4e6df42e6f397a05e94d34.tar.bz2
manifest-426f1a69770f515a9d4e6df42e6f397a05e94d34.zip
Add README
Change-Id: Ia88215a8c0e5322feaa3f0d3df40beb5ef866a7e
Diffstat (limited to 'README.mkdn')
-rw-r--r--README.mkdn37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.mkdn b/README.mkdn
new file mode 100644
index 0000000..a522bf7
--- /dev/null
+++ b/README.mkdn
@@ -0,0 +1,37 @@
+CyanogenMod
+===========
+
+Submitting Patches
+------------------
+Patches are always welcome! Please send pull requests with your patches! If at all possible please rebase your
+repository before sending a pull request. You can do this by using the following command:
+
+ git pull --rebase git://github.com/CyanogenMod/path_to_project.git gingerbread
+
+This makes accepting patches MUCH easier for our comitters.
+
+Getting Started
+---------------
+
+To get started with Android/CyanogenMod, you'll need to get
+familiar with [Git and Repo](http://source.android.com/download/using-repo).
+
+To initialize your local repository using the CyanogenMod trees, use a command like this:
+
+ repo init -u git://github.com/CyanogenMod/android.git -b gingerbread
+
+Then to sync up:
+
+ repo sync
+
+Please see the [CyanogenMod Wiki](http://wiki.cyanogenmod.com/) for building instructions.
+
+For more information on this Github Organization and how it is structured,
+please [read the wiki article](http://wiki.cyanogenmod.com/index.php/Github_Organization)
+
+Buildbot
+--------
+
+All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable.
+
+You can view the current build statuses at [buildbot.teamdouche.net](http://buildbot.teamdouche.net/)