mirror of
https://github.com/JustinZeus/Wholphin.git
synced 2026-07-08 15:50:16 +02:00
Update development.md with info on setting up the dev environment
This commit is contained in:
parent
f77d345abf
commit
5b21e352bc
1 changed files with 10 additions and 2 deletions
|
|
@ -23,9 +23,17 @@ We follow GitHub's fork & pull request model for contributions.
|
|||
|
||||
After forking and cloning your fork, you can import the project into Android Studio.
|
||||
|
||||
You need a compatible Android Studio version for the configured AGP. This is generally `Narwhal 3 Feature Drop | 2025.1.3` or newer. See https://developer.android.com/build/releases/gradle-plugin and [`libs.versions.toml](./gradle/libs.versions.toml).
|
||||
### Development environment
|
||||
|
||||
### Code organization
|
||||
It is recommended to use a recent version of [Android Studio](https://developer.android.com/studio). Make sure the [version is compatible](https://developer.android.com/build/releases/gradle-plugin#android_gradle_plugin_and_android_studio_compatibility) with Wholphin's AGP version.
|
||||
|
||||
Code formatting should follow [ktlint's](https://github.com/pinterest/ktlint) rules. Find the `ktlint` version in [`.pre-commit-config.yaml`](./.pre-commit-config.yaml). Optionally, install the [ktlint plugin](https://plugins.jetbrains.com/plugin/15057-ktlint) in Android Studio to run automatically. Configure the version in `Settings->Tools->KtLint->Ruleset Version`.
|
||||
|
||||
Also, it's recommend to add an extra ruleset jar for Compose-specific KtLint: https://mrmans0n.github.io/compose-rules/ktlint/#using-with-ktlint-cli-or-the-ktlint-intellij-plugin
|
||||
|
||||
Also setup [pre-commit](https://github.com/pre-commit/pre-commit) which will run `ktlint` as well on each commit, plus check for other common issues.
|
||||
|
||||
## Code organization
|
||||
|
||||
Code is split into several packages:
|
||||
- `data` - app-specific data models and services
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue