update README.md

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