Introduction

Lawnicons is an icon pack that replicates Android 13's themed icons in a consistent way. This document describes basic things you should know when developing code for Lawnicons. If you want to add an icon, see CONTRIBUTING.md for the icon guidelines.

Setup

• Download and install the latest canary version of Android Studio and the Android SDK. You may use the stable version, but some things might not function.
• Clone the git repository: git clone https://github.com/LawnchairLauncher/lawnicons.git
• Open the project in Android Studio

App architecture

Lawnicons uses Modern Android Development principles. These include the following libraries:

• Jetpack Compose with Material 3 theme for the UI
• Kotlin with [spotless](https://github.com/diffplug/spotless) for formatting code
• Dagger Hilt for dependency injection
• Retrofit for HTTP requests

Modules overview

Lawnicons contains two modules: app and svg-processor.

app module

The app module contains most of the code relating to the app. See "About the app module`" for additional information.

svg-processor module

The svg-processor processes the SVGs from the app. See the processing SVGs page for more info.