aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..88e4f7d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Script Materializer
+a.k.a. Fsck for Virtools
+
+## Functionality
+ - Dumping behavior scripts to JSON
+ - Spawning building blocks with custom GUID (may not work)
+ - ~~Destroying your hard disk~~
+
+## Building
+ 0. Dependencies: Virtools SDK and jsoncpp
+ 1. Change those fscking hardcoded absolute paths in the project
+ 2. Hit "Build Solution"!
+ 3. ~~Wait for your hard disk to be destroyed~~
+
+## License
+ 3-Clause BSD