diff --git a/README.md b/README.md index 02d42047..c5e1d3df 100644 --- a/README.md +++ b/README.md @@ -8,36 +8,40 @@ If you want to contribute, hop on the Discord server and say hi!

- + - + - +

## Installation + [Get it on Google Play](https://play.google.com/store/apps/details?id=de.wger.flutter) +alt="Get it on Google Play" +height="80">](https://play.google.com/store/apps/details?id=de.wger.flutter) [Get it on F-Droid](https://f-droid.org/packages/de.wger.flutter/) +alt="Get it on F-Droid" +height="80">](https://f-droid.org/packages/de.wger.flutter/) ## Development ### 1 + Install the [wger server](https://github.com/wger-project/wger), the easiest way is to start the development docker-compose: Alternatively, you can use one of our test servers, just ask us for access. ### 2 + Install Flutter, and all its dependencies, and create a new virtual device: . The app currently uses flutter 3.3 ### 3 + Create a new file ``wger.properties`` in ``fastlane/metadata/envfiles/``: ```properties @@ -50,17 +54,18 @@ to allow (a probably dedicated) user on the wger server to register users on its behalf. For this, generate an API KEY by visiting on your local instance and then run ``python3 manage.py add-user-rest the username`` -You can later list all the registered users with: ``python3 manage.py list-users-api`` - +You can later list all the registered users with: ``python3 manage.py list-users-api`` ### 4 + Start the application with ``flutter run`` or use your IDE -(please note that depending on how you run your emulator you will need to change the IP address of the server) +(please note that depending on how you run your emulator you will need to change the IP address of +the server) You can run the tests with the ``flutter test`` - ## Translation + Translate the app to your language on [Weblate](https://hosted.weblate.org/engage/wger/). [![translation status](https://hosted.weblate.org/widgets/wger/-/mobile/multi-blue.svg)](https://hosted.weblate.org/engage/wger/) @@ -86,7 +91,6 @@ conditions that are incompatible with the AGPL, provided that the source is also available under the AGPL with or without this permission through a channel without those restrictive terms and conditions. - The initial exercise and ingredient data is licensed additionally under one of the Creative Commons licenses, see the individual exercises for more details.