diff --git a/README.md b/README.md new file mode 100644 index 0000000..b15798d --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Dependencies + +- [`flutter`](https://flutter.dev/docs/get-started/install) +- [`gomobile`](https://godoc.org/golang.org/x/mobile/cmd/gomobile) +- Copy `env.sh.example` to `env.sh` and update your `PATH` variable to expose both flutter and go bin directories + + ```export PATH="$PATH:/path/to/go/bin:/path/to/flutter/bin``` + +# Formatting + +`flutter format` can be used to format the code in `lib` and `test` but it's default is 80 char line limit, it's 2020 + +Use: +```sh +flutter format lib/ test/ -l 120 +``` + +# Release + +Update `version` in `pubspec.yaml` to reflect this release, then + +## Android + +`flutter build appbundle --no-shrink` + +This will create an android app bundle at `build/app/outputs/bundle/release/` + +Upload the android bundle to the google play store https://play.google.com/apps/publish + +## iOS + +In xcode, Release -> Archive then follow the directions to upload to the app store. If you have issues, https://flutter.dev/docs/deployment/ios#create-a-build-archive +