Update README.md

This commit is contained in:
Roland Geider
2021-01-23 23:36:18 +01:00
parent 3d7f3d82a6
commit 23ed28e753

View File

@@ -1,16 +1,37 @@
# flutter wger
# Mobile app for wger
Mobile app for wger written with flutter.
Mobile app for wger written with flutter, still in early stages of development.
As soon as it is finished, it will be published in the different play stores.
Very very very much in the absolute early stages
If you want to contribute, hop on the discord server and say hi!
## Getting Started
Install wger, the easiest way is starting the docker-compose file:
Install wger, the easiest way is starting the development docker-compose:
<https://github.com/wger-project/wger>
Install flutter, all its dependencies and create a new virtual device:
<https://flutter.dev/docs/get-started/install>
Then run ``flutter run`` or use your IDE
Then run ``flutter run`` or use your IDE (please note that depending on how
you run your emulator you will need to change the IP address)
## Contact
Feel free to contact us if you found this useful or if there was something that
didn't behave as you expected. We can't fix what we don't know about, so please
report liberally. If you're not sure if something is a bug or not, feel free to
file a bug anyway.
* **discord:** <https://discord.gg/rPWFv6W>
* **issue tracker:** <https://github.com/wger-project/flutter/issues>
* **twitter:** <https://twitter.com/wger_project>
## License
The application is licensed under the GNU General Public License 3 or later (GPL 3+).
The initial exercise and ingredient data is licensed additionally under one of
the Creative Commons licenses, see the individual exercises for more details.