Merge branch 'master' of https://github.com/TeamWisp/WispInstaller

TeamWisp · Apr 16, 2019 · 78d66ed · 78d66ed
2 parents e5092af + 26c7f6d
commit 78d66ed
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# WispInstaller
+
+A rust tool that helps newbies to use cmake.
+
+## Usage
+
+Place the `.exe`in the root directory of the project (WispRenderer) and run it. Then just folow the on-screen instructions.
+
+## Installing Environment
+
+Requirements:
+* Rust
+
+Running the application in debug:
+```sh
+cargo run
+```
+
+Building for release:
+```sh
+cargo build --release
+```