Skip to content

Commit c63372d

Browse files
committed
Added README
1 parent fbe4066 commit c63372d

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
1-
# wear_accel
1+
# Mario Jump
22

3-
A new Flutter project.
3+
My wife got me a Samsung Watch4 and I discovered that there weren't enough silly apps for the platform. So, because I'd been meaning to try and do this with my phone anyway, and Flutter 3 had just come out, I'd go ahead and make the app.
44

5-
## Getting Started
5+
All it really does is listen for acceleration events on the X axis and when you hit a limit the sound file of Mario from Super Mario Bros. plays with some basic limits to keep it from playing more than once.
6+
7+
If you're wearing a WearOS watch the X axis is to the left and right directions, or 9 and 3 o'clock, if you're looking at the watch face. For a phone the orientation is the same. A bit of polishing could be done to make left and right hand options but if you set your G-force limit and swing your arm up like Mario when you jump it works and makes kids (and me) laugh.
8+
9+
## Installation
10+
11+
There are Android apk files in the ```releases``` folder that you can side load into your phone or watch. The process varies a bit by device but generally you head into Settings, the About section, then tap on the version number a bunch of times. That gets you a new Developer Mode in the Settings menu and from there you can enable sideloading of apps either via USB, WiFi, or Bluetooth. Personal preference from there is to use the official ```adb``` debugging tool for Android. You can find that tool in the Android command line tools package here: https://developer.android.com/studio#command-tools
12+
13+
## Development
14+
15+
If you were to diff this against a stock Fluttert project you'd find a few lines of code in ```main.dart``` and package entries in ```pubspec.yaml```, updates to icon files, and that's about it.
16+
17+
Once you've got the basic Flutter demo project running on a system you should be able to clone this and with a quick ```flutter pub get``` to pull in packages it should run locally.
18+
19+
## Stock Flutter "Getting Started" Section
620

721
This project is a starting point for a Flutter application.
822

0 commit comments

Comments
 (0)