From 925f2b65cba7f8075de2e827e6412e9a7be1a3c1 Mon Sep 17 00:00:00 2001
From: Yann <comte.yannick@gmail.com>
Date: Mon, 31 Mar 2025 13:38:19 +0200
Subject: [PATCH] Updated readme

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index adae860..416559f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
 # unreal-launcher
 
-A simple Unreal Engine project launcher mainly for *nix OS.
\ No newline at end of file
+A simple Unreal Engine project launcher mainly for *nix OS.
+
+## How to
+Edit the `project.json` file with your projects and unreal installation path, then run the app.
+
+### Installing deps
+```bash
+go get fyne.io/fyne/v2@latest
+go mod tidy
+```
+
+### Running the app
+```bash
+go run .
+``` 
+
+### Building the app
+```bash
+go build .
+./unreal-pm
+```
+
+## License
+This project is released under the MIT license.