aixan/lawnchair
1
0
Fork 0
mirror of https://github.com/LawnchairLauncher/lawnchair.git synced 2026-02-27 15:26:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README for Lawnchair 12

Browse Source
This commit is contained in:
Patryk Michalik
2021-10-24 16:08:08 +02:00
parent 9463d1a18f
commit 2cd10fcd8a
1 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -1,14 +1,14 @@
# Lawnchair 11
# Lawnchair 12
[![Build debug APK](https://github.com/LawnchairLauncher/lawnchair/actions/workflows/build_debug_apk.yml/badge.svg)](https://github.com/LawnchairLauncher/lawnchair/actions/workflows/build_debug_apk.yml)
[![Build release APK](https://github.com/LawnchairLauncher/lawnchair/actions/workflows/build_release_apk.yml/badge.svg)](https://github.com/LawnchairLauncher/lawnchair/actions/workflows/build_release_apk.yml)
[![Crowdin](https://badges.crowdin.net/e/188ba69d884418987f0b7f1dd55e3a4e/localized.svg)](https://lawnchair.crowdin.com/lawnchair)
Lawnchair is a free, open-source home app for Android. Taking Launcher3 — Android’s default home app — as a starting point, it ports Pixel Launcher features and introduces rich options for customization. This branch houses the codebase of Lawnchair 11, currently in alpha and based on Launcher3 from Android 11. For Lawnchair 9 and 10, see the branches with the `9-` and `10-` prefixes, respectively.
Lawnchair is a free, open-source home app for Android. Taking Launcher3—Android’s default home app—as a starting point, it ports Pixel Launcher features and introduces rich options for customization. This branch houses the codebase of Lawnchair 12, currently in alpha and based on Launcher3 from Android 12. For Lawnchair 9, 10, and 11, see the branches with the `9-`, `10-`, and `11-` prefixes, respectively.
## Contribute code
Whether you’ve fixed a bug or introduced a new feature, we welcome pull requests! (If you’d like to make a larger change and check with us first, you can do so via [Lawnchair’s Telegram group chat](https://t.me/lawnchairci).) To help translate Lawnchair 11 instead, please see “[Translate](#translate).”
Whether you’ve fixed a bug or introduced a new feature, we welcome pull requests! (If you’d like to make a larger change and check with us first, you can do so via [Lawnchair’s Telegram group chat](https://t.me/lawnchairci).) To help translate Lawnchair 12 instead, please see “[Translate](#translate).”
You can use Git to clone this repository:
@@ -16,29 +16,27 @@ You can use Git to clone this repository:
git clone --recursive https://github.com/LawnchairLauncher/lawnchair.git
```
- If you get build errors for `IconLoader` project resolution, run `git submodule update --init --recursive`
Lawnchair 11 uses [Jetpack Compose](https://developer.android.com/jetpack/compose); we suggest using a version of Android Studio that supports Compose tooling, such as Arctic Fox (2020.3.1). To build the app, select the `lawnWithQuickstepDebug` build type.
To build the app, select the `lawnWithQuickstepDebug` build type. Should you face errors relating to the `iconloaderlib` and `searchuilib` projects, run `git submodule update --init --recursive`.
Here are a few contribution tips:
- [The `lawnchair` package](https://github.com/LawnchairLauncher/lawnchair/tree/11-dev/lawnchair) houses Lawnchair’s own code, whereas [the `src` package](https://github.com/LawnchairLauncher/lawnchair/tree/11-dev/src) includes a clone of the Launcher3 codebase with modifications. Generally, place new files in the former, keeping changes to the latter to a minimum.
- [The `lawnchair` package](https://github.com/LawnchairLauncher/lawnchair/tree/12-dev/lawnchair) houses Lawnchair’s own code, whereas [the `src` package](https://github.com/LawnchairLauncher/lawnchair/tree/12-dev/src) includes a clone of the Launcher3 codebase with modifications. Generally, place new files in the former, keeping changes to the latter to a minimum.
- You can use either Java or, preferably, Kotlin.
- Make sure your code is logical and well formatted. If using Kotlin, see [“Coding conventions” in the Kotlin documentation](https://kotlinlang.org/docs/coding-conventions.html).
- Set `11-dev` as the base branch for pull requests.
- Set `12-dev` as the base branch for pull requests.
## Translate
You can help translate Lawnchair 11 [on Crowdin](https://lawnchair.crowdin.com/lawnchair). Here are a few tips:
You can help translate Lawnchair 12 [on Crowdin](https://lawnchair.crowdin.com/lawnchair). Here are a few tips:
- When using quotation marks, insert the symbols specific to the target language, as listed in [this table](https://en.wikipedia.org/wiki/Quotation_mark#Summary_table).
- Lawnchair uses title case for some English UI text. Title case isn’t used in other languages; opt for sentence case instead.
- Some English terminology may have no commonly-used equivalents in other languages. In such cases, use short descriptive phrases — for example, the equivalent of _bottom row_ for _dock_.
- Some English terminology may have no commonly used equivalents in other languages. In such cases, use short descriptive phrases—for example, the equivalent of _bottom row_ for _dock_.
## Quick links