blob: 1c8c939dfb33048ddb54b994f5d1c11f5a418c1b [file] [log] [blame]
Chris Soyars878bc022011-11-14 21:41:03 -05001CyanogenMod
2===========
3
4Submitting Patches
5------------------
6Patches are always welcome! Please submit your patches via CyanogenMod Gerrit!
7You 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
Steve Kondik843fa912012-07-10 11:22:52 -070014 repo start jellybean .
Chris Soyars878bc022011-11-14 21:41:03 -050015 (Make your changes and commit)
16 repo upload .
17Note: "." meaning current directory
18For more help on using this tool, use this command: repo help upload
19
20Make your changes and commit with a detailed message, starting with what you are working with (i.e. vision: Update Kernel)
21Commit your patches in a single commit. Squash multiple commit using this command: git rebase -i HEAD~<# of commits>
22
23To view the status of your and others' patches, visit [CyanogenMod Code Review](http://review.cyanogenmod.com/)
24
25
26Getting Started
27---------------
28
29To get started with Android/CyanogenMod, you'll need to get
30familiar with [Git and Repo](http://source.android.com/download/using-repo).
31
32To initialize your local repository using the CyanogenMod trees, use a command like this:
33
Steve Kondik843fa912012-07-10 11:22:52 -070034 repo init -u git://github.com/CyanogenMod/android.git -b jellybean
Chris Soyars878bc022011-11-14 21:41:03 -050035
36Then to sync up:
37
38 repo sync
39
40Please see the [CyanogenMod Wiki](http://wiki.cyanogenmod.com/) for building instructions.
41
42For more information on this Github Organization and how it is structured,
43please [read the wiki article](http://wiki.cyanogenmod.com/index.php/Github_Organization)
44
45Buildbot
46--------
47
48All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable.
49
Chirayu Desaiabd38d82012-07-07 12:14:52 +053050You can view the current build statuses at [CyanogenMod Jenkins](http://jenkins.cyanogenmod.com/)