From 164027eb13741548953cc00c4bd19a28c45f4686 Mon Sep 17 00:00:00 2001
From: KIT! <norththelittlefox@gmail.com>
Date: Wed, 6 Nov 2024 16:54:37 +0100
Subject: [PATCH] Added compilation details in README

Added a clean target in the makefile
---
 Makefile  | 10 +++++++++-
 README.md | 34 ++++++++++++++++++++++++++++++----
 2 files changed, 39 insertions(+), 5 deletions(-)

diff --git a/Makefile b/Makefile
index 6be9a04..c6dd3e3 100644
--- a/Makefile
+++ b/Makefile
@@ -1,9 +1,17 @@
+default: dist
+
 all:
 	@meson compile -C build
 	@strip build/bnusio.dll
 
 setup:
-	@meson setup build --cross cross-mingw-64.txt
+	@meson setup --wipe build --cross cross-mingw-64.txt
+
+clean:
+	@rm -rf out
+	@rm -rf build
+	@rm -f dist.7z
+	@cd subprojects && find . -maxdepth 1 ! -name packagefiles -type d -not -path '.' -exec rm -rf {} +
 
 dist-no-7z: all
 	@mkdir -p out/
diff --git a/README.md b/README.md
index 83203c0..b88c272 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,44 @@
 # TaikoArcadeLoader
 
-This is a loader for Taiko no Tatsujin Nijiiro ver.
+This is a loader for Taiko no Tatsujin Nijiiro ver.  
+It currently supports the following versions:
+
+* JPN 00.18
+* JPN 08.18
+* JPN 39.06
+* CHN 00.32 (based on JPN 32.09)
+
+## Compilation
+
+TaikoArcadeLoader can be a bit tricky to compile if you've never done it before.  
+Go to the TaikoArcadeLoader folder and run the following commands :
+
+```bash
+apt install -y npm mingw-w64 ninja-build nasm pip 7zip cmake
+pip3 install meson
+
+npm install n -g && n latest && npm install --global xpm@latest
+npx xpm init && npx xpm install @xpack-dev-tools/mingw-w64-gcc@latest
+
+# make sure to edit "path_to_tal" with the actual TaikoArcadeLoader folder path
+export PATH=/path_to_tal/xpacks/.bin:$PATH
+make setup
+```
+
+Once that's done, run `make` to compile TAL.  
+The output will be written at the root of the folder in `dist.7z`.
 
 ## Setup
 
-Copy the extracted contents of dist.zip to the same directory as Taiko.exe
+Copy the extracted contents of `dist.zip` to the same directory as Taiko.exe
 
 ### config.toml
 
 ```toml
 [amauth]
-# connection server
+# server ip
 server = "127.0.0.1"
-# connection port
+# server port
 port = "54430"
 # dongle serial
 chassis_id = "284111080000"