Skip to content

Commit

Permalink
chore(docs): Update build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
PapaTutuWawa committed Sep 8, 2023
1 parent c96880d commit 7655bef
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ repository, use `git clone --recursive https://codeberg.org/moxxy/moxxy.git`

In order to build Moxxy, you first have to run the code generator. To do that, first install all dependencies with
`flutter pub get`. Next, run the code generator using `flutter pub run build_runner build`. This builds required
data classes and the i18n support. Next, run `dart run pigeon --input pigeon/api.dart` to generate the communication
data classes and the i18n support. Next, run `dart run pigeon --input pigeon/quirks.dart` to generate the communication
channels with the native code.

Finally, you can build Moxxy using `flutter run`, if you want to test a change, or `flutter build apk --release` to build
Expand All @@ -61,7 +61,7 @@ can happen there. If you think your PR is ready for review, remove the "WIP: " p

In case you modified the Android-native code, please also make sure that you checked every item on the following checklist:

- [ ] I checked that [ktlint](https://github.com/pinterest/ktlint) is not showing any linting issues (`ktlint android/app/src/main/kotlin/org/moxxy/moxxyv2/ '!android/app/src/main/kotlin/org/moxxy/moxxyv2/Api.kt'`)
- [ ] I checked that [ktlint](https://github.com/pinterest/ktlint) is not showing any linting issues (`ktlint android/app/src/main/kotlin/org/moxxy/moxxyv2/ '!android/app/src/main/kotlin/org/moxxy/moxxyv2/quirks'`)

### Tips
#### `data_classes.yaml`
Expand Down
5 changes: 2 additions & 3 deletions android/app/src/main/kotlin/org/moxxy/moxxyv2/MainActivity.kt
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,8 @@ class MainActivity : FlutterActivity(), MoxxyQuirkApi {
}
}


override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
MoxxyQuirkApi.setUp(flutterEngine.dartExecutor.binaryMessenger, this);
MoxxyQuirkApi.setUp(flutterEngine.dartExecutor.binaryMessenger, this)
super.configureFlutterEngine(flutterEngine)
}

Expand All @@ -55,4 +54,4 @@ class MainActivity : FlutterActivity(), MoxxyQuirkApi {
lastEvent = null
return event
}
}
}
2 changes: 1 addition & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
--not-signed \
--zipalign ${sdk}/share/android-sdk/build-tools/34.0.0/zipalign \
--apksigner ${sdk}/share/android-sdk/build-tools/34.0.0/apksigner \
--pigeon ./pigeon/api.dart \
--pigeon ./pigeon/quirks.dart \
--flutter ${flutterVersion}/bin/flutter \
--dart ${flutterVersion}/bin/dart \
--provider-config ${providerArg} ${lib.optionalString skipBuild "--skip-build"}
Expand Down

0 comments on commit 7655bef

Please sign in to comment.