From ad2f3c702e5363c4a82a20369c8e2d1d49ea32cc Mon Sep 17 00:00:00 2001 From: Bryson Steck Date: Wed, 9 Jun 2021 23:07:39 -0600 Subject: updated doc --- README.md | 57 +++++++++++++++++++++++++++++++-------------------------- 1 file changed, 31 insertions(+), 26 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 44584d2..ceace68 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,30 @@ # Wiimmfi Watcher -Wiimmfi Watcher is an Android application that allows you to watch Mario Kart Wii gameplay by simply entering your friend code. This application can be found on the Google Play Store [here!](https://play.google.com/store/apps/details?id=me.brysonsteck.wiimmfiwatcher) This app can be used in English, German, French, Italian and Japanese. +Wiimmfi Watcher is an unofficial Android application that allows you to watch Mario Kart Wii gameplay by simply entering your friend code. This application can be found on the Google Play Store [here!](https://play.google.com/store/apps/details?id=me.brysonsteck.wiimmfiwatcher) This app can be used in several different languages. This application is currently being maintained by myself out of love for Mario Kart Wii and appreciation for the developers of Wiimmfi. I am in no way affiliated with Wiimmfi or any of the Wiimmfi developers. ## Screenshots -![](screenshots/sc-1.png) -![](screenshots/sc-1-dark.png) -![](screenshots/sc-2.png) -![](screenshots/sc-3.png) -![](screenshots/sc-3-dark.png) -![](screenshots/sc-4.png) -![](screenshots/sc-5.png) -![](screenshots/sc-6.png) -![](screenshots/sc-7.png) +![Main Screen](screenshots/sc-1.png) +![Main Screen in Dark Mode (for versions of Android that support it)](screenshots/sc-1-dark.png) +![Simply insert the friend code...](screenshots/sc-2.png) +![... And there is the room!](screenshots/sc-3.png) +![Dark Mode variant of the room screen.](screenshots/sc-3-dark.png) +![Press the menu button on the right for more display options.](screenshots/sc-4.png) +![Selecting an option changes the data on the right.](screenshots/sc-5.png) +![The app shows you what data is being displayed in the menu.](screenshots/sc-6.png) +![You can change data views at any point.](screenshots/sc-7.png) ## Download -You can visit the Google Play Store to download the most recent and stable version (link goes here once approved). You are also free to clone the repository and download the source code for the most stable release in the Releases tab if you would like to build it from scratch. +You can visit the Google Play Store to download the most recent and stable version [here!](https://play.google.com/store/apps/details?id=me.brysonsteck.wiimmfiwatcher) You are also free to clone the repository and download the source code for the most stable release in the Releases tab if you would like to build it from scratch. -## Feedback +## Feedback and Bugs This is officially my first project and Google Play app that I'm maintaining, so if you have any feedback about my work, I would love to hear it! You can create an issue tagged "feedback", or you can fill out this [Google Form](https://docs.google.com/forms/d/e/1FAIpQLSd6qCONAP2tsbHPgzu_CdZcHVHL5nx7q0XFqrVfExEc84kqUQ/viewform). I also have a section in my TODO list under "Features I would like to add" for things I am already considering adding to future releases. -## Bugs - -If you found any bugs in the `master` branch (i. e. the most recent Google Play release), **PLEASE READ MY [TODO LIST](https://github.com/brysonsteck/wiimmfi-watcher/blob/dev/TODO.md) FIRST** to make sure that the bug you found isn't something I'm already aware of. Once you have made sure of that, you can then create an issue or fill out this [Google Form](https://docs.google.com/forms/d/e/1FAIpQLSd6qCONAP2tsbHPgzu_CdZcHVHL5nx7q0XFqrVfExEc84kqUQ/viewform). - -## Devices - -Wiimmfi Watcher has been officially tested and confirmed to work on the following devices: -* x86_64 emulated Pixel 4 (Android 5.0.2) by brysonsteck -* x86_64 emulated Pixel 4 (Android 11) by brysonsteck -* x86_64 emulated Nexus 7 (Android 10) by brysonsteck -* x86_64 emulated Nexus 10 (Android 10) by brysonsteck -* x86_64 emulated Nexus 7 (Android 5.0.2) by brysonsteck -* x86_64 emulated Nexus 10 (Android 5.0.2) by brysonsteck +Additionally, If you find any bugs in the app (the `master` branch contains the same code as the latest release), you can create an issue here on GitHub or fill out the Google Form linked before in a similar manner. Please only submit bugs that pertain to the [most recent release.](https://github.com/brysonsteck/wiimmfi-watcher/releases) ## Donations @@ -44,7 +32,7 @@ This application is completely free, ad-less and open source. That means that no If you'd like to donate to this project, I'd ask that you first [donate to Wiimmfi.](https://wiimmfi.de/donate) This app nor my 3,069+ hours of fun on their service would not be possible without them. -Once you donate to them or you choose not to (why?? :( ), then here are ways you can donate to me: +Once you donate to them or you choose not to (why?? :( how sad), then here are ways you can donate to me: * [PayPal](https://www.paypal.com/donate/?business=steck.bryson%40gmail.com&item_name=Bryson+Steck¤cy_code=USD&Z3JncnB0=) * Bitcoin: 1Kbnp5JMTKd7a3Zs2WWm2JMCjfVb5tpcky * Litecoin: LRboJVNzoJCjXHmwN6RQgyvYEQjjaFzEA7 @@ -52,6 +40,23 @@ Once you donate to them or you choose not to (why?? :( ), then here are ways you Please note that donations are **NOT** required and does **NOT** add or remove functionality from the app. +## License + +© 2021 Bryson Steck. Wiimmfi Watcher is licensed under the [GPL-3.0](LICENSE). + +Wiimmfi Watcher is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +Wiimmfi Watcher is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with Wiimmfi Watcher. If not, see . + ## Credits Wiimmfi Watcher is made possible by the following: -- cgit v1.2.3 From 0c0d4b9bb1c532a1b6f9178ad9b4db3144381e01 Mon Sep 17 00:00:00 2001 From: Bryson Steck Date: Wed, 9 Jun 2021 23:16:39 -0600 Subject: updated credits in readme --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ceace68..e2ae102 100644 --- a/README.md +++ b/README.md @@ -60,5 +60,6 @@ along with Wiimmfi Watcher. If not, see . ## Credits Wiimmfi Watcher is made possible by the following: -* [Jsoup](https://jsoup.org) HTML parser, version 1.13.1 - +* [Wiimmfi](https://wiimmfi.de) for being the complete backbone of this app. +* [Jsoup](https://jsoup.org) version 1.13.1, which powers getting the information from Wiimmfi with HTML parsing. (This will soon be replaced in favor of JSON parsing.) +* [Gson](https://github.com/google/gson) version 2.8.7, which powers the updater (coming in 1.1.4). -- cgit v1.2.3 From 3c10ea67a3dab3d221e609d8dc6bc0df145f1220 Mon Sep 17 00:00:00 2001 From: Bryson Steck Date: Mon, 28 Jun 2021 23:04:29 -0600 Subject: updated doc for 1.1.4 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index e2ae102..6f14830 100644 --- a/README.md +++ b/README.md @@ -62,4 +62,4 @@ along with Wiimmfi Watcher. If not, see . Wiimmfi Watcher is made possible by the following: * [Wiimmfi](https://wiimmfi.de) for being the complete backbone of this app. * [Jsoup](https://jsoup.org) version 1.13.1, which powers getting the information from Wiimmfi with HTML parsing. (This will soon be replaced in favor of JSON parsing.) -* [Gson](https://github.com/google/gson) version 2.8.7, which powers the updater (coming in 1.1.4). +* [Gson](https://github.com/google/gson) version 2.8.7, which powers the updater. -- cgit v1.2.3