Update README.md

Wrote README

diff --git a/README.md b/README.md
index 60b3ba616f24d0f52dca23f91d82738608b8e933..baec11660e6c44ba0d26dabce44a0c76f3d9536a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,21 @@
-vndc
+vndc - VNDC is Not a Direct Clone (of VNDS ;P)
 ====
 
-VNDC is Not a Direct Clone (of VNDS ;P)
+tl;dr
+
+Install SDL2, SDL2_mixer, SDL_image, SDL_ttf
+Run ./build in the source dir.
+You should get a binary named vndc in bin.
+Run vndc -h if you don't know how to run it. Have VNDS files ready.
+
+-----
+
+This is a clone of vnds. Actually, it's an enhanced (in my opinion) version.
+
+After converting Fate/Stay night to vnds format, I started poking through the scripts' format. My first thought was 'this format is simple'.
+
+So I went and coded a VNDS interpreter. I named it VNDC, and made the name recursive for lulz.
+
+Currently, I can say confidently that it runs on Linux. It will probably also work on *bsd, if you can get SDL2, SDL_mixer, SDL_image, and SDL_ttf. I'm going to tweak stuff in the next release to build on windows, and I'll test it on mac using my MacBook '03 in the one after that. I have not tried building with clang. Lemme know how that goes.
+
+The ultimate goal is for this to run on Linux, Windows, Mac, Android, and (jailbroken) iOS. Note that I'll never make a binary for iOS unjailbroken because A) apple and B) this is an interpreter.