From 878bc02af963c471e1aedbc8d8f9769a7fa57b24 Mon Sep 17 00:00:00 2001 From: Chris Soyars Date: Mon, 14 Nov 2011 21:41:03 -0500 Subject: [PATCH] Add README --- README.mkdn | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 README.mkdn diff --git a/README.mkdn b/README.mkdn new file mode 100644 index 0000000..fcb5c99 --- /dev/null +++ b/README.mkdn @@ -0,0 +1,50 @@ +CyanogenMod +=========== + +Submitting Patches +------------------ +Patches are always welcome! Please submit your patches via CyanogenMod Gerrit! +You can do this by using these commands: + + (From root android directory) + . build/envsetup.sh + (Go to repo you are patching, make your changes and commit) + cmgerrit + + repo start ics . + (Make your changes and commit) + repo upload . +Note: "." meaning current directory +For more help on using this tool, use this command: repo help upload + +Make your changes and commit with a detailed message, starting with what you are working with (i.e. vision: Update Kernel) +Commit your patches in a single commit. Squash multiple commit using this command: git rebase -i HEAD~<# of commits> + +To view the status of your and others' patches, visit [CyanogenMod Code Review](http://review.cyanogenmod.com/) + + +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 ics + +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/)