1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100755
index 0000000..a5547a5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Simple Speedometer

+

+A simple free speedometer, currently supporting Android.

+

+I made this because I was disappointed by all of the existing speedometer apps out there. They usually have ads, premium subscriptions, and features that I have no use for. This app simply shows the current speed once it is opened, and no more.

+

+## Building

+

+The only dependency for building this is to install the Flutter SDK and whatever SDKs are required for the platform that you would like to build for. Currently, I am only supporting Android, but I will accept patches to make this software work on other devices.

+

+Building an APK is as simple as running `flutter build apk`. Copy the file from the `build/app/outputs/flutter-apk/app-release.apk` to your device, and run the APK file to install it. You can run it as a desktop application using `flutter run`, which provides debugging utilities such as hot reload.

+

+## Contributing

+

+If you'd like to offer suggestions or improvements, email me at botahamec@outlook.com with your issue or patch file.

+

+## License

+

+Licensed under BSD Zero-Clause.