Update Readme
This commit is contained in:
parent
80f9063bda
commit
1d9bc75c45
1 changed files with 12 additions and 27 deletions
39
README.md
39
README.md
|
@ -1,22 +1,11 @@
|
|||
## Submitting Patches ##
|
||||
------------------
|
||||
Our ROM is open source, and patches are always welcome!
|
||||
You can send patches by using these commands:
|
||||
Our project is open source, and patches are always welcome!
|
||||
You can send patches by using:
|
||||
|
||||
cd <project>
|
||||
<make edits>
|
||||
git add -A
|
||||
git commit -m "commit message"
|
||||
git push ssh://<username>@gerrit.omnirom.org:29418/<project> HEAD:refs/for/android-8.1
|
||||
Pull request, right here on git.
|
||||
|
||||
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 [OmniROM Code Review](https://gerrit.omnirom.org)
|
||||
Contact @lj50036 on irc, Network: freenode, Channel: #twrp
|
||||
|
||||
|
||||
## Maintaining Authorship ##
|
||||
|
@ -53,12 +42,16 @@ let me fix it because I was found out!" message.
|
|||
## Getting Started ##
|
||||
---------------
|
||||
|
||||
To get started with OmniROM, you'll need to get
|
||||
To get started with OMNI sources to build TWRP, you'll need to get
|
||||
familiar with [Git and Repo](https://source.android.com/source/using-repo.html).
|
||||
|
||||
To initialize your local repository using the OmniROM trees, use a command like this:
|
||||
To initialize your local repository using the OMNIROM trees to build TWRP, use a command like this:
|
||||
|
||||
repo init -u git://github.com/omnirom/android.git -b android-8.1
|
||||
repo init -u git://github.com/minimal-manifest-twrp/platform_manifest_twrp_omni.git -b twrp-8.1
|
||||
|
||||
To initialize a shallow clone, which will save even more space, use a command like this:
|
||||
|
||||
repo init --depth=1 -u git://github.com/minimal-manifest-twrp/platform_manifest_twrp_omni.git -b twrp-8.1
|
||||
|
||||
Then to sync up:
|
||||
|
||||
|
@ -66,13 +59,5 @@ Then to sync up:
|
|||
|
||||
Then to build:
|
||||
|
||||
cd <source-dir>; . build/envsetup.sh; brunch <device_name>
|
||||
cd <source-dir>; export ALLOW_MISSING_DEPENDENCIES=true; . build/envsetup.sh; lunch omni_<device>-eng; mka recoveryimage
|
||||
|
||||
|
||||
If you need more information or a more detailed guide, click [here to see our wiki.](http://docs.omnirom.org)
|
||||
|
||||
Our official IRC Channels are hosted on Freenode:
|
||||
|
||||
[#omnirom - USERS](http://webchat.freenode.net/?channels=omnirom/)
|
||||
|
||||
[#omni - DEVELOPERS](http://webchat.freenode.net/?channels=omni/)
|
||||
|
|
Loading…
Reference in a new issue