From 0735578da9f369a07851e5f3ac1e78ff2c41faf8 Mon Sep 17 00:00:00 2001 From: David Griffith Date: Mon, 26 Aug 2019 15:59:30 -0700 Subject: [PATCH] Converted README to markdown. --- README => README.md | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) rename README => README.md (73%) diff --git a/README b/README.md similarity index 73% rename from README rename to README.md index 34d7973..4872780 100644 --- a/README +++ b/README.md @@ -1,6 +1,5 @@ -robotfindskitten -A Zen Simulation -Release 7 / Serial number 130320 / Inform v6.33 +# robotfindskitten: A Zen Simulation +**Release 7 / Serial number 130320 / Inform v6.33** [-] |\_/| http://www.robotfindskitten.org (+)=C |o o|__ Leonard Richardson (C) 1997, 2000 @@ -22,28 +21,25 @@ not. Move Robot with the cursor keys, the numeric keypad, or using the vi/rogue movement keys. The game ends when robotfindskitten. Alternatively, you may end the game by hitting the Esc or Q keys. - -========= -Build: || -========= +## Build The NKI files need to be converted into a form that can be included in an Inform6 program. A Perl script, nki2inf.pl, is provided for this -purpose. Invoke it like this: "nki2inf.pl *.nki > nki.inf". Now you +purpose. Invoke it like this: ````nki2inf.pl *.nki > nki.inf````. Now you can invoke Inform6 on kitten.inf - -======== -Notes || -======== -1) More than half of the code is taken up by non kitten items +## Notes +1. More than half of the code is taken up by non kitten items (NKIs). When I compiled the code with just five messages and no debugging code, the resulting binary was less than 10k bytes. -2) If it wasn't already abundantly obvious, this program won't +2. If it wasn't already abundantly obvious, this program won't compile to Glulx because of copious use of Z-machine assembly instructions. -3) Compiling for V5 or higher is required due to "style" calls. +3. Compiling for V5 or higher is required due to "style" calls. Is there a reason why someone would want to compile this for V4 or previous? +## License +The Inform6 edition of robotfindskitten is distributed under the +Artistic License 2.0 (https://opensource.org/licenses/Artistic-2.0). -- 2.31.1