Add readme

This commit is contained in:
Suphon Thanakornpakapong
2021-06-06 20:54:53 +07:00
parent 068d8352e1
commit 279ea4b5f1
2 changed files with 30 additions and 0 deletions

30
README.md Normal file
View File

@@ -0,0 +1,30 @@
# Lawnchair
![Lawnchair](banner.png)
Lawnchair is the customizable Pixel Launcher alternative. This Repository contains our full rewrite from scratch (simply known as V11),
if you were looking for our older V1 sources you can find the archive [here](https://github.com/LawnchairLauncher/Lawnchair-V1).
## How to Contribute?
If you know Java/Android and have some Kotlin knowledge you should quickly be able to start contributing to Lawnchair.
Make sure to generally add any new classes/resources to the `lawnchair/` subdirectory and try to make as little changes as necessary directly inside Launcher3 code.
Kotlin is preferred but we'll accept great contributions in Java as well. We'll happily accept all bug fixes and will most likely also accept your well thought out feature.
### Building
Alright, I admit it, our build variants are a bit of a mess right now. Make sure to choose one of the variants prefixed `lawnWithQuickstep*`
from the "Build Variants" menu in Android Studio.
## Translations
Wanna help us by translating Lawnchair to your own language? Just take a look at [our Crowdin page](https://lawnchair.crowdin.com/lawnchair).
## Graphics
The official Lawnchair graphics were designed by [Josh Baldassarre](https://www.uplabs.com/jshbldssrr) & [Lumiq Creative](https://lumiqcreative.com). Thanks a lot to those awesome designers!
## Useful links
[Website](https://lawnchair.app) - [Twitter](https://twitter.com/lawnchairapp) - [Telegram](https://t.me/lawnchair) -
[XDA Thread](https://forum.xda-developers.com/android/apps-games/lawnchair-customizable-pixel-launcher-t3627137) - [APK Mirror](https://www.apkmirror.com/apk/deletescape/lawnchair/)