From: chaoskagami Date: Fri, 6 May 2016 12:27:13 +0000 (-0400) Subject: update readme X-Git-Url: https://chaos.moe/g/?a=commitdiff_plain;h=97a11f306f55aa94e98b16ca9d7b56740a6d1f5f;p=vn%2Fvndc.git update readme --- diff --git a/README.md b/README.md index b6c07b9..4fa2fac 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ vndc - VNDC is Not a Direct Clone (of VNDS ;P) ==== -tl;dr - This is under heavy development. Clone an old revision until I'm done fixing the sad excuse for a build system here. +tl;dr - To install, do the standard autotools dance, e.g. `./autogen.sh && ./configure && make -j4 && make install` + +This is under heavy changes at the moment after about 2 years of general deadness. In general, I'm surprised the code aged as well as it did. Going to to get it working on 3DS and Android hopefully. ----- @@ -17,12 +19,12 @@ A picture says a thousand words. Have one. ![Screenie of Current State](https://raw.githubusercontent.com/chaoskagami/vndc/data/screenshot.png) +(While this screenie is two years old, there's no practical difference at the moment.) + This is a clone of vnds. Actually, it's an enhanced (objectively) version. Why? A better interpreter without artificial limits. It could be potentially possible to use this as a base for a commercial VN if you feel like changing things a bit. This is why I used the MIT license; I'm a free-use guy, not copyleft. ;) This came about 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 and Windows (with proper compilers - read: mingw, I hate VC and will make no effort to support it). It will probably also work on *bsd, if you can get SDL2, SDL_mixer, SDL_image, and SDL_ttf. I'll test it on mac using my MacBook '03 sometime soon. 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. - -There was a initial attempt at android in-tree recently, but I have to rethink my approach since I had nothing but black screens of...nothing. Oh, and dalvik faults. No clue. +The ultimate goal is for this to run on anything that supports SDL2, Android, and 3DS' with CFW. Note that I'll not do iOS or Mac myself - I don't have any access to a compiler for any modern version of OSX and I can't exactly build an interpreter unless I'm targeting Jailbreak-only, anyways. But given a proper macports tree, you shouldn't have a terribly difficult time building it against SDL2.