From 1fe63a96bab1468103fa3d82911aef2f4672c4b6 Mon Sep 17 00:00:00 2001 From: Bruno Martins Date: Tue, 24 Jul 2018 11:12:09 +0100 Subject: [PATCH] lineage: Simplify README and update with minor fixes * Deduplicate info that is already in the Wiki Change-Id: I8d7b8192332c8d5a1756ac55a15f72aa59ffb6a4 --- README.mkdn | 51 +++++++++++++++++++-------------------------------- 1 file changed, 19 insertions(+), 32 deletions(-) diff --git a/README.mkdn b/README.mkdn index f70e24f1..93302541 100644 --- a/README.mkdn +++ b/README.mkdn @@ -1,50 +1,37 @@ 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 - - repo start lineage-15.1 . - (Make your changes and commit) - repo upload . -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 [LineageOS Code Review](http://review.lineageos.org/) - - -Getting Started +Getting started --------------- To get started with Android/LineageOS, you'll need to get 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 - +``` +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 sync -Please see the [LineageOS Wiki](http://wiki.lineageos.org/) for building instructions, by device. +Submitting patches +------------------ +Patches are always welcome! Please submit your patches via LineageOS Gerrit! + +Simply follow our guide on [how to submit patches](https://wiki.lineageos.org/submitting-patch-howto.html). + +To view the status of your and others' patches, visit [LineageOS Gerrit Code Review](https://review.lineageos.org/). -For more information on this Github Organization and how it is structured, -please [read the wiki article](http://wiki.lineageos.org/w/Github_Organization) Buildbot -------- -All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable. +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 in the [Jenkins](http://jenkins.lineageos.org) tool. +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/).