diff options
| author | Mica White <botahamec@outlook.com> | 2026-09-28 19:23:35 -0400 |
|---|---|---|
| committer | Mica White <botahamec@outlook.com> | 2026-09-28 19:23:35 -0400 |
| commit | 1c8fee757e6125ff510f07106fb6304e89b2fad5 (patch) | |
| tree | 7b1d4b885ded011de77fc77389d86de0ffaf7a05 /README.md | |
Condense all commits into one commit
At some point, I think I committed the Flutter binary. It's too deep to
fix it now. At this point, I think my only solution is to delete my .git
directory and re-initialize it.
Diffstat (limited to 'README.md')
| -rwxr-xr-x | README.md | 19 |
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.
|