To get started with the CarbonROM sources, you'll need to get familiar with Git and Repo.
You will need to set up some directories in your build environment.
To create them run:
mkdir -p ~/bin
mkdir -p ~/carbon
Enter the following to download the "repo" binary and make it executable:
curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > ~/bin/repo && chmod a+x ~/bin/repo
You may need to reboot for these changes to take effect. Now enter the following to initialize the repository:
cd ~/CarbonROM
repo init -u https://github.com/CarbonROM/android.git -b cr-5.1 && repo sync -f
PLEASE NOTE THAT YOU MUST USE THE -f flag when repo syncing/initializing if you want to sync with our default -j8 setup as android.googlesource seems to like to reject your requests if you set your -jflag too high. if you wish to avoid this issue run it repo sync -j1 otherwise -f (force) is recommended so it will resync the repos it gets error codes on. Thank you and have a nice day.
Please note that if you are building on Mac OS X, you are required to install coreutils from MacPorts before you continue. Initialize the environment with the envsetup.sh script. Note that replacing "source" with a single dot saves a few characters, and the short form is more commonly used in documentation.
. build/envsetup.sh
lunch
Enter the number of the build you want to start and press enter
Build the Code:
make carbon -j8 (or as many threads your hardware can handle)
Patches are always welcome! Please submit your patches via CarbonROM Gerrit! You can do this by using these commands:
Setting up for repo upload: (run these commands once)
git config --global review.review.carbonrom.org.username <Your username registered at CarbonROM gerrit>
git config --global review.review.carbonrom.org.email <Your email registered at CarbonROM gerrit>
(From root android directory)
. build/envsetup.sh
repo start cr-5.1 .
(Make your changes and commit)
repo upload .
As of January 1st, 2017, we will only allow GPG signed commits on our Gerrit/GitHub orgs, as well as require a signed push. You can set up signed commits by setting up the key accoridng to these directions on the Git-SCM Site and adding them to Gerrit
You can enable the signed push with:
git config --global push.gpgSign if-asked
and enable signing your commits with:
git config --global commit.gpgsign true
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 CarbonROM Code Review
If you have any issues/questions please contact us in channel: #carbonrom //General-related questions #carbonrom-dev //Development-related questions
server: irc.freenode.net
You can find all CarbonROM Resources that need to be themed here Let us know when there is anything else we can help with, we will gladly do.
We use crowdin for our ROMs translation. If you want to help with that, you can do so here. https://crowdin.com/project/carbonrom
The available projects to translate will be updated when new things come into Carbon, so be sure to keep on checking the page. Thanks a lot to those who helped translating the ROM!