M README.md => README.md +22 -0
@@ 1,1 1,23 @@
# Aotearoa Tides
An app that displays tidal data using [the official LINZ tide predictions](https://www.linz.govt.nz/sea/tides/tide-predictions).
Aotearoa Tides is written in [Flutter](https://flutter.dev/) which is a cross
platform library for developing native Android or iOS apps. Currently, the app
is only tested on Android. To build it yourself install flutter, and the [android
development toolchain](https://developer.android.com/studio). You can use `flutter
doctor` to ensure your install is working properly.
Finally: `flutter build apk`
Aotearoa Tides uses a public mailing list for contributions and discussion. You can
browse the list [here](https://lists.sr.ht/~kota/public-inbox) and
[email patches](https://git-send-email.io) or questions to
project is licensed under the GPL3-or-later and contributions are welcome!
A screenshot_01.png => screenshot_01.png +0 -0