summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorcyBerta <cyberta@riseup.net>2022-06-09 01:53:27 +0200
committercyBerta <cyberta@riseup.net>2022-06-09 01:53:27 +0200
commit568ee211b417f5b3632e22f61a28cedcbb89cc51 (patch)
tree47e2c09efa030644bd98086d518ec0d3d966fb21 /README.md
parent45991eb28aa8898614caaca2ede3d99fbd84c571 (diff)
add section in readme as a reminder to avoid unit tests in debug builds
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2794acc1..fbf172cc 100644
--- a/README.md
+++ b/README.md
@@ -183,6 +183,16 @@ If you want to build and sign apks and aab bundles for the current commit, run:
Please check `./prepareFordistribution.sh -h` for all options!
+### Running unit tests
+
+Unit tests should always run against release builds, it is expected that some tests fail in debug builds.
+
+You can execute all unit tests from the command line with:
+
+```bash
+ ./gradlew testCustomProductionFatReleaseUnitTest testNormalProductionFatReleaseUnitTest
+```
+
## Supported Versions <a name="supported-versions"></a>
Currently API 16 (Android 4.1) - API 30 (Android 11) are officially supported. Keep backwards compatibility in mind if you plan to contribute new features.