summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2025-12-23 21:00:59 +0100
committerxengineering <me@xengineering.eu>2025-12-23 21:00:59 +0100
commita80d6baacbbb4d1c168f14b40a295688022cadad (patch)
treee225948ff8d1b51c74cf68714bd2ae35c1be13a8 /README.md
parent1e8a6233b8c50fb0ad429d91e2937a7917915347 (diff)
downloadsia-app-a80d6baacbbb4d1c168f14b40a295688022cadad.tar
sia-app-a80d6baacbbb4d1c168f14b40a295688022cadad.tar.zst
sia-app-a80d6baacbbb4d1c168f14b40a295688022cadad.zip
Document usage
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1bb1f3e..dd48005 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,16 @@
-# sia_app
+# Sia app
-Sia app
+## Usage
+
+The app can be run in debug mode allowing a hot-reload.
+
+```
+flutter run
+```
+
+A release version can be built for all the targets individually.
+
+```
+flutter build linux
+flutter build apk
+```