From 4faf0c9aa3fcb4569a65bd79e7b98e7a7b61e655 Mon Sep 17 00:00:00 2001
From: Alexander Tarasov <a.tevg@ya.ru>
Date: Tue, 18 Mar 2025 17:46:36 +0300
Subject: [PATCH] update README.md

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/README.md b/README.md
index e69de29..2ecc5f5 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,46 @@
+# build_msp
+_A tool that helps to build .msp file mod_
+
+---
+
+### How to use
+```
+Usage: build_msp [OPTIONS]
+
+Options:
+  -i, --input <INPUT>        [default: .]
+  -o, --output <OUTPUT>      [default: mod.msp]
+  -m, --manifest <MANIFEST>  [default: ./manifest]
+  -h, --help                 Print help
+  -V, --version              Print version
+
+```
+
+### Manifest example
+```
+titleid=0100D3F008746000
+version=65536
+patchset=kpnp_russ
+```
+- titleid - title_id of a game (required)
+- version - recommended game version (optional)
+- patchset- name for the .ips patches directory (optional)
+
+### Installing using cargo
+You can install build_msp from crates.io
+```cargo install build_msp```
+
+### Building
+1. Install [Rust Lang](https://www.rust-lang.org/tools/install)
+2. Clone this repository (including switch-tools submodule)
+
+    ```git clone --recursive https://github.com/arabianq/build_msp```
+3. Build the program using Cargo
+
+    ```cd build_msp; cargo build --release```
+4. Done. Now there is a binary in _target/release_ directory
+
+### Notes
+- **build_romfs** and **build_pfs0** from [switch-tools](https://github.com/switchbrew/switch-tools) are used
+- Supports romfs, exefs and ips mods
+- Supports confg.ini and icon.jpg
\ No newline at end of file