From cb0e9a390bc58d225411c7d6b8f424cd3dcdd2b8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20K=C3=BCrten?= <sebastian@mobanisto.de>
Date: Thu, 30 Sep 2021 10:44:39 +0200
Subject: [PATCH] Add section 'Building and Running' to readme

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

diff --git a/README.md b/README.md
index 163263f27c..b6fadf76b6 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,21 @@ to build its UI. The Intellij IDEA plugin
 provides static previews of
 composable functions without parameters which are annotated with `@Preview`.
 
+### Building and Running
+
+In order to build and run the application from the command line, execute this:
+
+    ./gradlew run
+
+You can specify arguments to the app using the `--args` option of the
+Gradle task. For example to show the usage info:
+
+    ./gradlew run --args="--help"
+
+To specify a different data directory and enable the debug output:
+
+    ./gradlew run --args="--debug --data-dir=/tmp/briar-tmp"
+
 ## Translations
 
 See [TRANSLATION.md](./TRANSLATION.md) for more information.
-- 
GitLab