blob: d132d1d1ac16b97ad91f57c68a5988a06d8a69f5 [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
Aayush Gupta3b3bee12021-05-17 14:47:41 +05307To get started with Android/LineageOS, you'll need to get familiar with [Source Control Tools](https://source.android.com/setup/develop).
Chris Soyars878bc022011-11-14 21:41:03 -05008
Dan Pasanen48d5ebd2016-12-26 23:21:25 -06009To initialize your local repository using the LineageOS trees, use a command like this:
Bruno Martins23b40d02018-07-24 12:14:36 +010010```
Michael Bestas2fca1232021-10-05 16:18:45 +030011repo init -u git://github.com/LineageOS/android.git -b lineage-19.0
Bruno Martins23b40d02018-07-24 12:14:36 +010012```
Chris Soyars878bc022011-11-14 21:41:03 -050013Then to sync up:
Bruno Martins23b40d02018-07-24 12:14:36 +010014```
15repo sync
16```
17Please see the [LineageOS Wiki](https://wiki.lineageos.org/) for building instructions, by device.
Chris Soyars878bc022011-11-14 21:41:03 -050018
Chris Soyars878bc022011-11-14 21:41:03 -050019
Bruno Martins23b40d02018-07-24 12:14:36 +010020Submitting patches
21------------------
22Patches are always welcome! Please submit your patches via LineageOS Gerrit!
23
24Simply follow our guide on [how to submit patches](https://wiki.lineageos.org/submitting-patch-howto.html).
25
26To view the status of your and others' patches, visit [LineageOS Gerrit Code Review](https://review.lineageos.org/).
Chris Soyars878bc022011-11-14 21:41:03 -050027
Chris Soyars878bc022011-11-14 21:41:03 -050028
29Buildbot
30--------
31
Harry Youdf68ed962017-07-09 10:20:18 +010032All 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 -050033
Bruno Martinsb9752fc2020-12-09 19:48:11 +000034You can view the current build statuses at [LineageOS Buildkite](https://buildkite.com/lineageos).
Harry Youdf68ed962017-07-09 10:20:18 +010035
Bruno Martins23b40d02018-07-24 12:14:36 +010036Builds produced weekly by the buildbot can be downloaded from [LineageOS downloads](https://download.lineageos.org/).