From c1c73f5ee037f04d68354b329b3b05ba9f4d224f Mon Sep 17 00:00:00 2001
From: TimHasert <27998143+TimH96@users.noreply.github.com>
Date: Sun, 20 Aug 2023 22:55:29 +0200
Subject: [PATCH] document scripts

---
 scripts/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 scripts/README.md

diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644
index 0000000..9990545
--- /dev/null
+++ b/scripts/README.md
@@ -0,0 +1,16 @@
+# Scripts
+
+These scripts are used to scrape and parse the game data from other sources into a workable format. They are not part of the actual app, but rather are kept here for documentation and repeatability in case the data model every requires some changes. There are some dependency between the scripts, so the order of execution matter and goes as follows:
+
+1. `get-skills.py`
+2. `get-equipment-and-decos.py`
+
+## Sources
+
+### Skill Categories
+
+Skill categories were made manually, analogous to the Monster Hunter Tri ASS. 
+
+### Skills, Equipment and Decorations
+
+All the equipment and decoration data, as well as exact skill names, were obtained from platypete and their [Monster Hunter Dos wiki](https://mh1g-wiki.herokuapp.com/mh2/). The japanese names were manually removed as they were messing with parsing.