From b8d3773ffee8e36f244d32bfebf398f9c20c0f34 Mon Sep 17 00:00:00 2001
From: Vincent Velociter <vincent.velociter@gmail.com>
Date: Fri, 21 Mar 2025 17:09:40 +0100
Subject: [PATCH] Add setup and run instruction in the readme

---
 README.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d8822da6f..e4a28039c 100644
--- a/README.md
+++ b/README.md
@@ -8,10 +8,40 @@ Contributions to this project are welcome!
 
 If you want to contribute, please read the [contributing guide](./CONTRIBUTING.md).
 
-## Setup and Run
+## Setup
+
+tl;dr: Install Flutter, clone the repo, run in order:
+- `flutter pub get`
+- `dart run build_runner watch`
+- `flutter analyze --watch`,
+
+and you're ready to code!
 
 See [the dev environment docs](./docs/setting_dev_env.md) for detailed instructions.
 
+## Running the app
+
+To run the app, you can use the following command:
+
+```bash
+# if not already done, run the code generation
+dart run build_runner build
+
+# run the app on all available devices
+flutter run -d all
+```
+
+## Running tests
+
+To run the tests, you can use the following command:
+
+```bash
+# if not already done, run the code generation
+dart run build_runner build
+
+flutter test
+```
+
 ## Internationalisation
 
 Do not edit the `app_en.arb` file by hand, this file is generated.