From 3f854be0a037730273a15a0ac7114fad8bceed1b Mon Sep 17 00:00:00 2001
From: "google-labs-jules[bot]"
 <161369871+google-labs-jules[bot]@users.noreply.github.com>
Date: Thu, 30 Apr 2026 08:49:04 +0000
Subject: [PATCH] docs: rewrite README.md to be more comprehensive and visually
 appealing

Co-authored-by: jac3km4 <11986158+jac3km4@users.noreply.github.com>
---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 41 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index e97393a..2b6f71d 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,53 @@
-# vakfu
-Wakfu map renderer
+# 🌍 Vakfu
 
-![Imgur](https://i.imgur.com/dx6mHVB.jpg)
+**Vakfu** is an open-source Rust implementation of a map renderer for Wakfu, powered by the [Bevy](https://bevyengine.org/) game engine and the [byte](https://github.com/jac3km4/byte) crate for parsing game assets.
 
-# building
+![Vakfu Screenshot](https://i.imgur.com/dx6mHVB.jpg)
 
-This project requires [cargo](https://crates.io) to build.
+---
+
+## 🛠️ Building
+
+This project requires [Rust and Cargo](https://rustup.rs/) to build.
+
+### Dependencies
+
+If you are building on Ubuntu or a similar Linux distribution, you will need to install several system dependencies for the Bevy engine. You can do this with:
+
+```bash
+sudo apt-get install pkg-config libwayland-dev libxkbcommon-dev libasound2-dev libudev-dev
+```
+
+### Compiling
+
+Once everything is in place, you can build the project by running:
 
-Once everything is in place:
 ```bash
-cargo build
+cargo build --release
 ```
 
-# using
+---
 
+## 🚀 Using
+
+To run Vakfu, you need to point it to your local installation of Wakfu and specify a map ID.
+
+```bash
+cargo run --release -- --path /home/user/games/Ankama/Wakfu --map 999
+```
+
+Alternatively, if you've built the executable:
 
 ```bash
-vakfu --path /home/jekky/games/Ankama/Wakfu --map 999
+./target/release/vakfu --path /home/user/games/Ankama/Wakfu --map 999
 ```
 
-Note that this project does not include **any** authored assets. In order to run it, you may get such assets by obtaining a copy of the game Wakfu, created by Ankama Games.
+### ⚠️ Disclaimer
+
+This project **does not include any authored assets**. In order to run it, you must obtain a copy of the game *Wakfu*, created and owned by [Ankama Games](https://www.ankama.com/en/games/wakfu).
+
+---
+
+## 📄 License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.