From e79790d7de3545f533aa27ee2f47265c8db67977 Mon Sep 17 00:00:00 2001
From: timerix <timerix11@gmail.com>
Date: Sat, 18 Mar 2023 06:27:47 +0600
Subject: [PATCH] README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cc0a858
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Paradox Mod Merger
+A piece of shitty code i wrote to simplify merging Paradox Interacive's game modifications. 
+Works for HOI4 and Stellaris.  
+
+## Installation
+1. install 7z and add it to path
+2. install dotnet7.0 sdk  
+3. ```sh
+   cp Makefile some_mod_colletion_dir/
+   ```
+4. set `CSPROJ_DIR` and `STEAMLIB_DIR` in `Makefile`
+5. ```shell
+   make update_merger
+   ```
+6. ```shell
+   make create_dirs
+   ```
+
+
+## dir structure
+```xpath
+separate/ mods sorted by categories
+├── content/ 
+├── graphics/
+├── localisation/
+├── post/
+├── pre/
+├── ui/
+└── unused/                 
+src/                      
+├── src_yyy.MM.dd_hh-mm-ss/  
+│   └── ... unsorted mods copied from steam workshop copied by clean_workshop task   
+└── ...  
+merged/
+└── ... merged mod categories
+````