README

README.md

@@ -5,17 +5,25 @@ Works for HOI4 and Stellaris.
 ## Installation
 1. install 7z and add it to path
 2. install dotnet7.0 sdk  
-3. ```sh
+3. copy `Makefile` in a new directory where mod merging will be happening
-   cp Makefile some_mod_colletion_dir/
+4. set `CSPROJ_FILE` and `WORKSHOP_DIR` in `Makefile`
-   ```
+5. Build mod merger and copy it to your directory. On windows use `/usr/bin/make` (from MSYS2 repository) instead of `/mingw64/bin/make`
-4. set `CSPROJ_DIR` and `STEAMLIB_DIR` in `Makefile`
+    ```shell
-5. ```shell
+    make update_merger
-   make update_merger
+    ```
-   ```
+6. Prepare directories for each mod cathegory
-6. ```shell
+    ```shell
-   make create_dirs
+    make create_dirs
-   ```
+    ```
+7. Copy mods from workshop directory to human-readable directories.
+	Automatically deletes trash files mod developers forgot about. Downloads mod descriptions from steam workshop.
+    ```shell
+    make clear_workshop
+    ```
+8. Copy mods from src/ to separate/ according to their cathegory.
+    - Example: `src/src_1999.12.31/Merger of rules` -> `separate/pre/Merger of rules`
 
+9. Now you can merge each cathegory using command `make <cathegory>`. See other options of **stellasis-mod-merger** by command `./merger -h`.
 
 ## dir structure
 ```xpath