From 568ee211b417f5b3632e22f61a28cedcbb89cc51 Mon Sep 17 00:00:00 2001
From: cyBerta <cyberta@riseup.net>
Date: Thu, 9 Jun 2022 01:53:27 +0200
Subject: add section in readme as a reminder to avoid unit tests in debug
 builds

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'README.md')

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.
-- 
cgit v1.2.3