From 74f9c14eb1918624725267947e3366b6f465ea0e Mon Sep 17 00:00:00 2001 From: Mica White Date: Sun, 28 Dec 2025 19:02:19 -0500 Subject: Add a useful README --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index cb3fda8..a5547a5 100755 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ -# speedometer +# Simple Speedometer -A new Flutter project. +A simple free speedometer, currently supporting Android. -## Getting Started +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. -This project is a starting point for a Flutter application. +## Building -A few resources to get you started if this is your first Flutter project: +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. -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +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. -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +## 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. -- cgit v1.2.3