|
1 |
| -Paintroid |
2 |
| -========= |
| 1 | +# Paintroid |
3 | 2 |
|
4 |
| -Paintroid, also known as **Pocket Paint**, is associated |
5 |
| -to [Catroid](https://github.com/Catrobat/Catroid). It is a graphical paint editor application for |
6 |
| -the Android platform that, among others, allows setting parts of pictures to transparent. |
| 3 | +Paintroid, also known as **Pocket Paint**, is associated to [Catroid](https://github.com/Catrobat/Catroid). It is a graphical paint editor application for the Android platform that, among others, allows setting parts of pictures to transparent. |
7 | 4 |
|
8 |
| -Since Pocket Paint is now available in **Google Play store** you can also download Paintroid (Pocket |
9 |
| -Paint) from [here](https://play.google.com/store/apps/details?id=org.catrobat.paintroid). |
10 |
| -Alternatively, you can find it on ** |
11 |
| -F-Droid** [here](https://f-droid.org/packages/org.catrobat.paintroid/). |
| 5 | +Since Pocket Paint is now available in **Google Play store** you can also download Paintroid (Pocket Paint) from [here](https://play.google.com/store/apps/details?id=org.catrobat.paintroid). Alternatively, you can find it on **F-Droid** [here](https://f-droid.org/packages/org.catrobat.paintroid/). |
12 | 6 |
|
13 |
| -For more information oriented towards developers please visit |
14 |
| -our [developers page](http://developer.catrobat.org/). |
| 7 | +For more information oriented towards developers please visit our [developers page](http://developer.catrobat.org/). |
15 | 8 |
|
16 | 9 | > **Note** This repository is the Flutter version of [Paintroid](https://github.com/Catrobat/Paintroid)
|
17 | 10 |
|
18 | 11 | ## Getting Started
|
19 | 12 |
|
20 |
| -1. Install [Flutter](https://docs.flutter.dev/get-started/install) |
21 |
| - - check the currently used version in file ".github/workflows/main.yml" |
22 |
| -2. Set up the [Protocol Buffer](https://grpc.io/docs/languages/dart/quickstart/) compiler |
23 |
| - - `protoc` for Dart |
24 |
| -4. Get dependencies - `flutter pub get` |
25 |
| -5. Build supporting files - `./generate_files.sh` |
26 |
| -6. Build protobuf files - `./generate_protos.sh` |
27 |
| -7. Run app - `flutter run lib/main.dart` |
| 13 | +1. Install [Flutter](https://docs.flutter.dev/get-started/install): |
| 14 | + - Currently used version specified in _.github/workflows/main.yml_ |
| 15 | + - **Recommended**: Use [fvm](https://fvm.app/) for managing Flutter versions |
| 16 | +2. Get dependencies: `make get` |
| 17 | +3. Run app: `make run` |
| 18 | + |
| 19 | +> In case `make` does not work for you, `melos` can be used for most of the commands. Check them out in _Makefile_ or in _melos.yaml_. |
| 20 | +
|
| 21 | +What `make get` does: |
| 22 | + |
| 23 | +- Runs `./setup-sdk.sh`, if _fvm_ is not installed: |
| 24 | + - changes "FLUTTER" (= `fvm flutter`) to `flutter` in _Makefile_ |
| 25 | + - changes "DART" (= `fvm dart`) to `dart` in _Makefile_ if _fvm_ |
| 26 | + - changes "sdkPath" (= `.fvm/flutter_sdk`) to `auto` in _melos.yaml_ |
| 27 | +- Runs `./setup-melos.sh`: activates _melos_ if not activated. |
| 28 | + |
| 29 | +## Building generated files |
| 30 | + |
| 31 | +- For **protoc**: |
| 32 | + - Set up the [Protocol Buffer](https://grpc.io/docs/languages/dart/quickstart/) compiler |
| 33 | + - Run `./generate_protos.sh` |
| 34 | +- For **build-runner**: run `make build` |
| 35 | +- For **localizations**: run `make languages` |
28 | 36 |
|
29 | 37 | ## Tests
|
30 | 38 |
|
31 |
| -1. For unit tests, run `flutter test` at the project root |
32 |
| -2. For integration tests - |
33 |
| - - Make sure you have an iOS/Android device online by running `flutter devices` |
34 |
| - - Run `flutter test integration_test -d <DEVICE-ID>` |
35 |
| - > **Note** Replace `<Device-ID>` with the ID of the device from previous command |
| 39 | +- Run tests for **all** packages: |
| 40 | + - all: `make test` |
| 41 | + - unit: `make test-unit` |
| 42 | + - widget: `make test-widget` |
| 43 | +- Run tests for a **specific** package: |
| 44 | + - all: `melos test` |
| 45 | + - unit: `melos test-unit` |
| 46 | + - widget: `melos test-widget` |
| 47 | + |
| 48 | +**For integration tests:** |
| 49 | + |
| 50 | +1. Make sure you have an iOS/Android device online by running `flutter devices` |
| 51 | +2. `cd` into the package where the test is located |
| 52 | +3. Run `flutter test <path-to-integartion-test> -d <DEVICE-ID>` |
| 53 | + - Replace `<Device-ID>` with the ID of the device from `flutter devices` |
| 54 | + - Replace `<path-to-integartion-test>` with the actual path to the test (_test/..._) |
36 | 55 |
|
37 |
| -# Issues # |
| 56 | +## Issues |
38 | 57 |
|
39 |
| -**Please report all bugs on |
40 |
| -our [Jira Bugtracker](https://jira.catrob.at/secure/CreateIssue.jspa?pid=10401&issuetype=1)** |
| 58 | +**Please report all bugs on our [Jira Bugtracker](https://jira.catrob.at/secure/CreateIssue.jspa?pid=10401&issuetype=1)** |
41 | 59 |
|
42 |
| -# Contributing # |
| 60 | +## Contributing |
43 | 61 |
|
44 |
| -If you want to contribute we suggest that you start |
45 |
| -with [forking](https://help.github.com/articles/fork-a-repo/) our repository and browse the code. |
46 |
| -Then you can look at our [Issue-Tracker](https://jira.catrob.at/secure/RapidBoard.jspa?rapidView=60) |
47 |
| -and start with fixing one ticket. We strictly |
48 |
| -use [Test-Driven Development](http://c2.com/cgi/wiki?TestDrivenDevelopment) |
49 |
| -and [Clean Code](http://www.planetgeek.ch/wp-content/uploads/2013/06/Clean-Code-V2.2.pdf), so first |
50 |
| -read everything you can about these development methods. Code developed in a different style will |
51 |
| -not be accepted. After you've created a pull request we will review your code and do a full testrun |
52 |
| -on your branch. |
| 62 | +If you want to contribute we suggest that you start with [forking](https://help.github.com/articles/fork-a-repo/) our repository and browse the code. Then you can look at our [Issue-Tracker](https://jira.catrob.at/secure/RapidBoard.jspa?rapidView=60) and start with fixing one ticket. We strictly use [Test-Driven Development](http://c2.com/cgi/wiki?TestDrivenDevelopment) and [Clean Code](http://www.planetgeek.ch/wp-content/uploads/2013/06/Clean-Code-V2.2.pdf), so first read everything you can about these development methods. Code developed in a different style will not be accepted. After you've created a pull request we will review your code and do a full testrun on your branch. |
53 | 63 |
|
54 |
| -If you want to implement a new feature, please ask about the details in JIRA or our IRC channel ( |
55 |
| -#catrobat or #catrobatdev) first. |
| 64 | +If you want to implement a new feature, please ask about the details in JIRA or our IRC channel (#catrobat or #catrobatdev) first. |
56 | 65 |
|
57 |
| -Let's start to set up the working environment using the instructions in |
58 |
| -our [Wiki](https://github.com/Catrobat/Catroid/wiki/Setup-working-environment)! |
| 66 | +Let's start to set up the working environment using the instructions in our [Wiki](https://github.com/Catrobat/Catroid/wiki/Setup-working-environment)! |
59 | 67 |
|
60 |
| -# Resources and links # |
| 68 | +## Resources and links |
61 | 69 |
|
62 |
| -* [Google Play Store Download](https://play.google.com/store/apps/details?id=org.catrobat.paintroid) |
63 |
| -* [F-Droid Download](https://f-droid.org/packages/org.catrobat.paintroid/) |
64 |
| -* [Frequently Asked Questions](https://github.com/Catrobat/Catroid/wiki/Frequently-Asked-Questions) |
65 |
| -* [Credits](http://developer.catrobat.org/credits) |
66 |
| -* [Statistics on OpenHub](https://www.openhub.net/p/catrobat/) |
67 |
| -* [Twitter](http://twitter.com/Catroid) |
68 |
| -* [Our Google group](https://groups.google.com/forum/?fromgroups#!forum/catrobat) |
| 70 | +- [Google Play Store Download](https://play.google.com/store/apps/details?id=org.catrobat.paintroid) |
| 71 | +- [F-Droid Download](https://f-droid.org/packages/org.catrobat.paintroid/) |
| 72 | +- [Frequently Asked Questions](https://github.com/Catrobat/Catroid/wiki/Frequently-Asked-Questions) |
| 73 | +- [Credits](http://developer.catrobat.org/credits) |
| 74 | +- [Statistics on OpenHub](https://www.openhub.net/p/catrobat/) |
| 75 | +- [Twitter](http://twitter.com/Catroid) |
| 76 | +- [Our Google group](https://groups.google.com/forum/?fromgroups#!forum/catrobat) |
69 | 77 |
|
70 |
| -# License # |
| 78 | +## License |
71 | 79 |
|
72 | 80 | [License](http://developer.catrobat.org/licenses) of our project (mainly AGPL v3).
|
0 commit comments