diff --git a/README.md b/README.md new file mode 100644 index 0000000000..05915171de --- /dev/null +++ b/README.md @@ -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/) diff --git a/banner.png b/banner.png new file mode 100644 index 0000000000..b46f68c7a0 Binary files /dev/null and b/banner.png differ