blob: 32b095dfabffde618a5f687ebc20991c0e37067d [file] [log] [blame]
Dan Pasanen48d5ebd2016-12-26 23:21:25 -06001LineageOS
Chris Soyars878bc022011-11-14 21:41:03 -05002===========
3
Bruno Martins23b40d02018-07-24 12:14:36 +01004Getting started
Chris Soyars878bc022011-11-14 21:41:03 -05005---------------
6
Dan Pasanen48d5ebd2016-12-26 23:21:25 -06007To get started with Android/LineageOS, you'll need to get
Bruno Martins23b40d02018-07-24 12:14:36 +01008familiar with [Repo](https://source.android.com/source/using-repo.html) and [Version Control with Git](https://source.android.com/source/version-control.html).
Chris Soyars878bc022011-11-14 21:41:03 -05009
Dan Pasanen48d5ebd2016-12-26 23:21:25 -060010To initialize your local repository using the LineageOS trees, use a command like this:
Bruno Martins23b40d02018-07-24 12:14:36 +010011```
Michael Bestasaad75922019-10-25 20:11:55 +030012repo init -u git://github.com/LineageOS/android.git -b lineage-17.1
Bruno Martins23b40d02018-07-24 12:14:36 +010013```
Chris Soyars878bc022011-11-14 21:41:03 -050014Then to sync up:
Bruno Martins23b40d02018-07-24 12:14:36 +010015```
16repo sync
17```
18Please see the [LineageOS Wiki](https://wiki.lineageos.org/) for building instructions, by device.
Chris Soyars878bc022011-11-14 21:41:03 -050019
Chris Soyars878bc022011-11-14 21:41:03 -050020
Bruno Martins23b40d02018-07-24 12:14:36 +010021Submitting patches
22------------------
23Patches are always welcome! Please submit your patches via LineageOS Gerrit!
24
25Simply follow our guide on [how to submit patches](https://wiki.lineageos.org/submitting-patch-howto.html).
26
27To view the status of your and others' patches, visit [LineageOS Gerrit Code Review](https://review.lineageos.org/).
Chris Soyars878bc022011-11-14 21:41:03 -050028
Chris Soyars878bc022011-11-14 21:41:03 -050029
30Buildbot
31--------
32
Harry Youdf68ed962017-07-09 10:20:18 +010033All supported devices are built weekly and periodically as changes are committed to ensure the source trees remain buildable.
Chris Soyars878bc022011-11-14 21:41:03 -050034
Bruno Martins23b40d02018-07-24 12:14:36 +010035You can view the current build statuses at [LineageOS Jenkins](https://jenkins.lineageos.org/).
Harry Youdf68ed962017-07-09 10:20:18 +010036
Bruno Martins23b40d02018-07-24 12:14:36 +010037Builds produced weekly by the buildbot can be downloaded from [LineageOS downloads](https://download.lineageos.org/).