Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 56 additions & 22 deletions README.mkdn
Original file line number Diff line number Diff line change
@@ -1,36 +1,70 @@
LineageOS
===========

Getting started
---------------

To get started with Android/LineageOS, you'll need to get familiar with [Source Control Tools](https://source.android.com/setup/develop).
# Initialize local repository
```
repo init -u https://github.com/Lunaris-AOSP/android -b 16.2 --git-lfs
```

To initialize your local repository using the LineageOS trees, use a command like this:
# Sync up
```
repo init -u https://github.com/LineageOS/android.git -b lineage-23.2 --git-lfs
repo sync -c -j$(nproc --all) --force-sync --no-clone-bundle --no-tags
```
Then to sync up:

# Build

- Set up the build environment
```bash
. b*/env*
```
repo sync

- Lunch a target
```bash
lunch lineage_codename-bp4a-user
```
Please see the [LineageOS Wiki](https://wiki.lineageos.org/) for building instructions, by device.

- To start compiling
```bash
m bacon
```

Submitting patches
------------------
Patches are always welcome! Please submit your patches via LineageOS Gerrit!
- Paintainer prop (define in system/product prop)
```prop
ro.lunaris.maintainer=GHOST | ゴースト
```

Simply follow our guide on [how to submit patches](https://wiki.lineageos.org/submitting-patch-howto.html).
- refresh rate list (optional) - defining this flags makes the controller skip the parsing of Display.Mode refresh rates
- for supported refresh rates. The refresh rate controller will also assume that all the defined refresh rates are "supported"
```make
TARGET_SUPPORTED_REFRESH_RATES := 60,90,120,144
```

To view the status of your and others' patches, visit [LineageOS Gerrit Code Review](https://review.lineageos.org/).
- If device support UDFPS
```make
TARGET_CUSTOM_UDFPS := true
```

- For GMS
```make
WITH_GMS := true
```

Buildbot
--------
- For bcr
```make
WITH_BCR := true
```

All supported devices are built weekly and periodically as changes are committed to ensure the source trees remain buildable.
- Set surfaceflinger refreshrate
```make
$(call soong_config_set,surfaceflinger,frame_rate_category_high,120)
$(call soong_config_set,surfaceflinger,frame_rate_category_min,60)
```

You can view the current build statuses at [LineageOS Buildkite](https://buildkite.com/lineageos).
- Whether the device supports Smart Pixels(frameworks overlay)
```make
<!-- Whether the device supports Smart Pixels -->
<bool name="config_supportSmartPixels">true</bool>
```

Builds produced weekly by the buildbot can be downloaded from [LineageOS downloads](https://download.lineageos.org/).
- Limit AOD refreshrate (SystemUI overlay)
```make
<!-- Preferred max refresh rate at AOD & Ambient Display, if supported by the display. -->
<integer name="config_aodMaxRefreshRate">60</integer>
```
Loading