From 437ea16d7c6a2532db19347e0f1cd985d93db8ae Mon Sep 17 00:00:00 2001
From: Vyn <vyn@evalyte.net>
Date: Fri, 24 May 2024 17:26:22 +0200
Subject: [PATCH] Update README with build && download instructions

---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 59e5cde..0a2d10e 100644
--- a/README.md
+++ b/README.md
@@ -13,16 +13,37 @@ with whatever you want and sync them using third party software (like Syncthing)
 
 ## Download
 
-### Linux
+You can download Mirai from the [releases page](https://codeberg.org/vyn/mirai/releases).  
 
-### Android
+Currently only `Linux (x86_64)` is officially supported.
 
 ## Build from source
 
 ### Requirements
 
+- Qt >= 6.7.0
+- GCC >= 14.1.1
+- CMake >= 3.29.3
+- Ninja (or Make but you will need to adapt the commands)
+- Git
+
 ### Steps
 
+Fetch and setup the repository:
+```
+git clone https://codeberg.org/vyn/mirai.git
+cd mirai
+git submodule update --init --recursive
+```
+
+To build:
+```
+cmake -DCMAKE_BUILD_TYPE=Release -S . -B ./build -G Ninja
+cd build
+ninja
+```
+Then you should have a `mirai` executable in the `build` directory you are currently in.
+
 ## License
 
 Copyright (C) Vyn 2024