Files
lawnchair/README.md

59 lines
4.0 KiB
Markdown
Raw Normal View History

# Lawnchair 12.1
2021-06-06 20:54:53 +07:00
2021-07-06 11:25:27 +02:00
[![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)
2022-11-10 21:13:51 +08:00
[![Telegram](https://img.shields.io/endpoint?url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Flccommunity)](https://t.me/lccommunity)
[![Discord](https://img.shields.io/discord/803299970169700402?label=server&logo=discord)](https://discord.gg/3x8qNWxgGZ)
2021-06-06 20:54:53 +07:00
> **This repository is currently in maintenance mode**. Our main developers currently do not have the time to contibute to the project, so only dependency updates and minor optimizations will be commited.
2023-04-12 08:03:00 +08:00
>
> *This doesn't mean that the project is dead.* It simply means that Lawnchairs development is stalled.
>
> If you have the time to contribute to Lawnchairs development, please contact a dev via [Telegram](https://t.me/lccommunity). We will gladly appreciate your help.
Lawnchair is a free, open-source home app for Android. Taking [Launcher3](https://android.googlesource.com/platform/packages/apps/Launcher3/) — Androids default home app — as a starting point, it ports Pixel Launcher features and introduces rich options for customization.
2023-04-12 08:03:00 +08:00
This branch houses the codebase of Lawnchair 12.1, currently in alpha and based on Launcher3 from Android 12.1. For older unsupported versions, see the branches with the `9-`, `10-`, `11-`, and `12-` prefixes.
2021-06-06 20:54:53 +07:00
2021-07-06 11:25:27 +02:00
## Contribute code
2021-06-06 20:54:53 +07:00
Whether youve fixed a bug or introduced a new feature, we welcome pull requests! (If youd like to make a larger change and check with us first, you can do so via [Lawnchairs Telegram group chat](https://t.me/lawnchairci).) To help translate Lawnchair 12.1 instead, please see “[Translate](#translate).”
2021-06-06 20:54:53 +07:00
2021-07-06 11:25:27 +02:00
You can use Git to clone this repository:
2021-06-06 20:54:53 +07:00
2021-07-06 11:25:27 +02:00
```
git clone --recursive https://github.com/LawnchairLauncher/lawnchair.git
2021-07-06 11:25:27 +02:00
```
2021-06-06 20:54:53 +07:00
2021-10-24 16:08:08 +02:00
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`.
2021-06-06 20:54:53 +07:00
2021-07-06 11:25:27 +02:00
Here are a few contribution tips:
2021-06-06 20:54:53 +07:00
- [The `lawnchair` package](https://github.com/LawnchairLauncher/lawnchair/tree/12.1-dev/lawnchair) houses Lawnchairs own code, whereas [the `src` package](https://github.com/LawnchairLauncher/lawnchair/tree/12.1-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.
2021-06-06 20:54:53 +07:00
2021-07-06 11:25:27 +02:00
- You can use either Java or, preferably, Kotlin.
2021-06-06 20:54:53 +07:00
2021-07-06 11:25:27 +02:00
- 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).
2021-06-06 20:54:53 +07:00
- Set `12.1-dev` as the base branch for pull requests.
2021-07-06 11:25:27 +02:00
## Translate
You can help translate Lawnchair 12.1 [on Crowdin](https://lawnchair.crowdin.com/lawnchair). Here are a few tips:
2021-07-06 11:25:27 +02:00
- 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 isnt 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 phrasesfor example, the equivalent of _bottom row_ for _dock_.
2021-07-06 11:25:27 +02:00
## Quick links
- [News](https://t.me/lawnchairci)
- [Lawnchair on Twitter](https://twitter.com/lawnchairapp)
- [Website](https://lawnchair.app)
- [_XDA_ thread](https://forum.xda-developers.com/t/lawnchair-customizable-pixel-launcher.3627137/)
You can view all our links on [the Lawnchair Wiki](https://github.com/LawnchairLauncher/lawnchair/wiki).