README.mkdn

   1 CyanogenMod
   2 ===========
   3
   4 Submitting Patches
   5 ------------------
   6 Patches are always welcome!  Please submit your patches via CyanogenMod Gerrit!
   7 You can do this by using these commands:
   8
   9     (From root android directory)
  10     . build/envsetup.sh
  11     (Go to repo you are patching, make your changes and commit)
  12     cmgerrit <for(new)/changes(patch set)> <branch/change-id>
  13
  14     repo start cm-14.0 .
  15     (Make your changes and commit)
  16     repo upload .
  17 Note: "." meaning current directory
  18 For more help on using this tool, use this command: repo help upload
  19
  20 Make your changes and commit with a detailed message, starting with what you are working with (i.e. vision: Update Kernel)
  21 Commit your patches in a single commit. Squash multiple commit using this command: git rebase -i HEAD~<# of commits>
  22
  23 To view the status of your and others' patches, visit [CyanogenMod Code Review](http://review.cyanogenmod.org/)
  24
  25
  26 Getting Started
  27 ---------------
  28
  29 To get started with Android/CyanogenMod, you'll need to get
  30 familiar with [Git and Repo](http://source.android.com/source/using-repo.html).
  31
  32 To initialize your local repository using the CyanogenMod trees, use a command like this:
  33
  34     repo init -u git://github.com/CyanogenMod/android.git -b cm-14.0
  35
  36 Then to sync up:
  37
  38     repo sync
  39
  40 Please see the [CyanogenMod Wiki](http://wiki.cyanogenmod.org/) for building instructions.
  41
  42 For more information on this Github Organization and how it is structured,
  43 please [read the wiki article](http://wiki.cyanogenmod.org/w/Github_Organization)
  44
  45 Buildbot
  46 --------
  47
  48 All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable.
  49
  50 You can view the current build statuses at [CyanogenMod Jenkins](http://jenkins.cyanogenmod.org/)