diff --git a/README.md b/README.md index 4cc7a84..f133394 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,17 @@ ## 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 - - git add -A - git commit -m "commit message" - git push ssh://@gerrit.omnirom.org:29418/ HEAD:refs/for/android-7.1 - -Register at 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) +Pull request, right here on git. +Contact me on irc, Network: freenode, Channel: #twrp ## Maintaining Authorship ## ---------------------- Mainting authorship is a very important aspect of working with Open Source code. If you wish to submit a patch/fix from anywhere else (another ROM, project, etc.), it is imperative that you maintain the ownership of the person whose -work you are seeking to include. Doing so will ensure that credit is given where it is deserved, and the [prinicples of open source](http://opensource.org/docs/osd) +work you're seeking to include. Doing so will ensure that credit is given where it is deserved, and the [prinicples of open source](http://opensource.org/docs/osd) are upheld. Your contribution to the project will still be recognized as you will forever be listed as the committer. If you manually cherry pick a patch/fix then you will need to add the original author prior to pushing to our [gerrit](https://gerrit.omnirom.org). @@ -53,12 +41,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-7.1 + repo init -u git://github.com/lj50036/platform_manifest_twrp_omni.git -b twrp-7.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/lj50036/platform_manifest_twrp_omni.git -b twrp-7.1 Then to sync up: @@ -66,13 +58,4 @@ Then to sync up: Then to build: - cd ; . build/envsetup.sh; brunch - - -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/) + cd ; . build/envsetup.sh; lunch omni_-eng; mka recoveryimage