From 30af5fbe9abbba7e36a822b4c2609ab1df013d7b Mon Sep 17 00:00:00 2001
From: argoneus <argoneus@poweris.moe>
Date: Fri, 6 Mar 2020 19:29:33 +0100
Subject: [PATCH] updated readme

---
 .gitignore       |  4 ++--
 README.md        | 21 +++++++++++++++++++++
 tools/.gitkeep   |  0
 tools/readme.txt | 34 ----------------------------------
 4 files changed, 23 insertions(+), 36 deletions(-)
 create mode 100644 README.md
 create mode 100644 tools/.gitkeep
 delete mode 100644 tools/readme.txt

diff --git a/.gitignore b/.gitignore
index f8d0fa1..cd455e6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,6 @@ __pycache__/
 *$py.class
 *.swp
 virtualenv/
-tools/*
-!tools/readme.txt
 .idea/
+tools/*
+!tools/.gitkeep
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ba0de08
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# divatool
+
+A tool for that one game everyone hates but works on anyway.
+
+## Requirements
+
+Divatool is written in and uses [Python 3](https://www.python.org/downloads/).
+
+There are also several third party dependencies not provided as part of this repository,
+mostly used for the `xdudata` command. You need to have the binaries of the following tools
+either in your `$PATH` variable or in the [`tools`](./tools) folder. These tools are:
+
+* [clHCA](https://github.com/KinoMyu/FastHCADecoder)
+* acb_extract
+* usm_extract
+
+Make sure these executables are called the same way on your machine.
+
+## Usage
+
+TODO
diff --git a/tools/.gitkeep b/tools/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/tools/readme.txt b/tools/readme.txt
deleted file mode 100644
index f10fdc0..0000000
--- a/tools/readme.txt
+++ /dev/null
@@ -1,34 +0,0 @@
-Various files need to be in this directory.
-If you don't have them, ask someone who does.
-
-The required files are:
-
-Binaries:
-- acb_extract.exe
-- usm_extract.exe
-- clHCA
-
-Z shell scripts:
-- update_bgm.zsh
-- update_movie.zsh
-- update_se.zsh
-- update_voice.zsh
-
-Python scripts:
-- adx_parse.py
-- bingo_fuck.py
-- chara_room_mission.py
-- custom_mission.py
-- event_bonus.py
-- orphan_quest.py
-- pad_2_csv.py
-- pad_2_json.py
-- pad_2_pad.py
-- pad_2_pad_louisstyle.py
-- pad_stat.py
-- pad_update.py
-- store_parser.py
-- tsv_2_pad.py
-- tsv_parse.py
-- txt_2_pad.py
-- utage_decrypt.py