diff options
| author | Bruno Martins <bgcngm@gmail.com> | 2018-07-24 12:14:36 +0100 |
|---|---|---|
| committer | razorloves <razorloves@gmail.com> | 2018-07-31 10:14:21 +0200 |
| commit | 23b40d0b29f789d46aba7bc10a27253404caa7c2 (patch) | |
| tree | 6e72802719f71e692ec879c9f8fcc559dd8067e8 /README.mkdn | |
| parent | 5e5ecc77e9b8d662db852533190cdedfc80e76f7 (diff) | |
| download | manifest-23b40d0b29f789d46aba7bc10a27253404caa7c2.tar.gz manifest-23b40d0b29f789d46aba7bc10a27253404caa7c2.tar.bz2 manifest-23b40d0b29f789d46aba7bc10a27253404caa7c2.zip | |
lineage: Simplify README and update with minor fixes
* Deduplicate info that is already in the Wiki
Change-Id: Ib479536051d0164f206c167a01f694a96bac65eb
Diffstat (limited to 'README.mkdn')
| -rw-r--r-- | README.mkdn | 49 |
1 files changed, 17 insertions, 32 deletions
diff --git a/README.mkdn b/README.mkdn index fdb5719..9330254 100644 --- a/README.mkdn +++ b/README.mkdn @@ -1,45 +1,30 @@ LineageOS =========== -Submitting Patches ------------------- - -Patches are always welcome! Please submit your patches via LineageOS Gerrit. -You can do this by using these commands: - - (From root android directory) - . build/envsetup.sh - (Go to repo you are patching, make your changes and commit) - lineagegerrit <for(new)/changes(patch set)> <branch/change-id> - - repo start lineage-15.1 . - (Make your changes and commit) - repo upload . - -Note: "." means the 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 commits using this command: `git rebase -i HEAD~<# of commits>` - -To view the status of your and others' patches, visit [LineageOS Code Review](https://review.lineageos.org/) - - -Getting Started +Getting started --------------- To get started with Android/LineageOS, you'll need to get -familiar with [Git and Repo](https://source.android.com/source/using-repo.html). +familiar with [Repo](https://source.android.com/source/using-repo.html) and [Version Control with Git](https://source.android.com/source/version-control.html). To initialize your local repository using the LineageOS trees, use a command like this: +``` +repo init -u git://github.com/LineageOS/android.git -b lineage-15.1 +``` +Then to sync up: +``` +repo sync +``` +Please see the [LineageOS Wiki](https://wiki.lineageos.org/) for building instructions, by device. - repo init -u git://github.com/LineageOS/android.git -b lineage-15.1 -Then to sync up: +Submitting patches +------------------ +Patches are always welcome! Please submit your patches via LineageOS Gerrit! - repo sync +Simply follow our guide on [how to submit patches](https://wiki.lineageos.org/submitting-patch-howto.html). -Please see the [LineageOS Wiki](https://wiki.lineageos.org/) for building instructions. +To view the status of your and others' patches, visit [LineageOS Gerrit Code Review](https://review.lineageos.org/). Buildbot @@ -47,6 +32,6 @@ Buildbot All supported devices are built weekly and periodically as changes are committed to ensure the source trees remain buildable. -You can view the current build statuses at [LineageOS Jenkins](https://jenkins.lineageos.org/) +You can view the current build statuses at [LineageOS Jenkins](https://jenkins.lineageos.org/). -Builds produced weekly by the buildbot can be downloaded from [LineageOS downloads](https://download.lineageos.org/) +Builds produced weekly by the buildbot can be downloaded from [LineageOS downloads](https://download.lineageos.org/). |