diff --git a/README.md b/README.md index fd52085..aa92c83 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,18 @@ # UI Compiler ----- - Scripts for easier editing of Unity assets for Higurashi. The main rust script will generate a new emip file, apply it to the assets and pack the assets into 7zip archive we need for a release. +## Documentation Notes + +Please note that documentation is in two places: + +1. This Readme.md file +2. [Detailed documentation with images etc. on this repository's Wiki](https://github.com/07th-mod/higurashi-dev-guides/wiki/UI-editing-scripts). + +Please look through the detailed documentation, especially if you're working on a new chapter, new language, or using UABE - this file does not contain information on those topics. + ## Prerequisites To use this tool you will need these prerequisites: