From f16b61a3684151be67cc3054979b31382bff3427 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A1chym=20Tou=C5=A1ek?= <enumag@gmail.com>
Date: Fri, 7 Sep 2018 19:03:47 +0200
Subject: [PATCH] Add readme

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a961961..45b6bc0 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
-# ui-editing-scripts
+UI Compiler
+----
+
 Scripts for easier editing of Unity assets for Higurashi.
+
+To use this tool you will need to install both Rust and Python. Then simply run this:
+
+```
+cargo run <chapter> <platform>
+```
+
+`<chapter>` is simply `onikakushi`, `watanagashi` and so on.
+
+`<platform>` is `win` or `mac`. For tatarigoroshi platform can also be `win-mg` and `mac-mg`.
+
+The script will generate a new emip file in the output directory which you can apply to assets file using UABE as described in the docs for the python scripts.
+
+If you want to use this tool to compile assets for a different language, you can change the files in the assets directory to your needs.