Add README.md

Change-Id: Ib9558dcab343e24ce619f5b6dc31faad9bf416d9
This commit is contained in:
mithun46 2013-10-18 04:36:32 -07:00 committed by Jacob Whatley
parent f173686a5f
commit 21ae90388d
No known key found for this signature in database
GPG key ID: 9A18E581795704A6

41
README.md Normal file
View file

@ -0,0 +1,41 @@
Submitting Patches
------------------
We're open source, and patches are always welcome!
You can send patches by using these commands:
cd <project>
<make edits>
git add -A
git commit -m "commit message"
git push ssh://<username>@gerrit.omnirom.org:29418/<project> HEAD:refs/for/<branch>
Register at gerrit.omnirom.org and use the username that you registered there in the above command
Commit your patches in a single commit. Squash multiple commit using this command: git rebase -i HEAD~<# of commits>
If you are going to make extra additions, just repeat steps (Don't start a new patch), but instead of git commit -m
use git commit --amend. Gerrit will recognize it as a new patchset.
To view the status of your and others patches, visit [OMNI ROM Code Review](https://gerrit.omnirom.org)
Getting Started
---------------
To get started with OMNI ROM, you'll need to get
familiar with [Git and Repo](http://source.android.com/download/using-repo).
To initialize your local repository using the OMNI trees, use a command like this:
repo init -u git://github.com/omnirom/android.git -b <branch>
Then to sync up:
repo sync
Then to build:
cd <source-dir>; . build/envsetup.sh; brunch <device_name>
If you need more information or a more detailed guide, check [Here](http://docs.omnirom.org)
Our Official IRC Channel: [#omnirom - USERS](http://webchat.freenode.net/?channels=omnirom) , [#omni - DEVS](http://webchat.freenode.net/?channels=omni)