Update interpreters to latest Garglk codebase
[projects/chimara/chimara.git] / interpreters / git / README.txt
index 2462bcf28ee94272e465de7468b7de6dd0a3393d..4161fdd488b6cfcdda821b540f44e134e4681c3b 100644 (file)
@@ -1,6 +1,6 @@
 Git is an interpreter for the Glulx virtual machine. Its homepage is here:\r
 \r
-  http://diden.net/if/git\r
+http://ifarchive.org/indexes/if-archiveXprogrammingXglulxXinterpretersXgit.html\r
 \r
 Git's main goal in life is to be fast. It's about five times faster than Glulxe,\r
 and about twice as fast as Frotz (using the same Inform source compiled for the\r
@@ -14,9 +14,12 @@ between each prompt.
 \r
 Have fun, and let me know what you think!\r
 \r
-  Iain Merrick\r
+  Iain Merrick (Original author)\r
   iain@diden.net\r
 \r
+  David Kinder (Current maintainer)\r
+  davidk.kinder@virgin.net\r
+\r
 --------------------------------------------------------------------------------\r
 \r
 * Building and installing Git\r
@@ -31,7 +34,8 @@ hard, depending on what kind of computer you're using and whether you want Git
 to be able to display graphics and play sounds. To find a suitable Glk library,\r
 look here:\r
 \r
-  http://eblong.com/zarf/glk\r
+http://eblong.com/zarf/glk/\r
+http://ifarchive.org/indexes/if-archiveXprogrammingXglkXimplementations.html\r
 \r
 Exactly how you build and link everything depends on what platform you're on and\r
 which Glk library you're using. The supplied Makefile should work on any Unix\r
@@ -46,8 +50,8 @@ respectively, but I can't guarantee that they're fully up-to-date.
 \r
 It should be possible to build Git with any C compiler, but it works best with\r
 GCC, because that has a non-standard extension that Git can use for a big speed\r
-boost. GCC 2.95 actually generates faster code than GCC 3, so if you have a\r
-choice, use the former. (On OS X, this means compiling with 'gcc2'.)\r
+boost. GCC 2.95 actually generates faster code than later versions, so if you\r
+have a choice, use the former. (On OS X, this means compiling with 'gcc2'.)\r
 \r
 --------------------------------------------------------------------------------\r
 \r
@@ -116,12 +120,9 @@ KB. 256KB is usually enough to store dozens of moves.
 \r
 GCC 3 has bigger problems than I thought. On PowerPC, the direct threading\r
 option results in much slower code; and on x86, terp.c crashes GCC itself if\r
-direct threading is used. Therefore, I recommend that you use GCC 2.95 if\r
-possible. If you only have GCC 3, don't define USE_DIRECT_THREADING, at least\r
-until the compiler bug is fixed.\r
-\r
-Since the previous update, GCC 4 has been released, but I haven't evaluated it\r
-yet. If you want to give it a try, let me know how you get on!\r
+direct threading is used. GCC 4 seems to work, given some very limited testing,\r
+but still results in slow code. Therefore, I recommend that you use GCC 2.95 if\r
+possible. If you only have GCC 3, don't define USE_DIRECT_THREADING.\r
 \r
 Some Glk libraries, such as xglk, can't deal with memory-mapped files. You can\r
 tell that this is happening if Git can open .ulx files, but complains that .blb\r
@@ -130,9 +131,9 @@ your startup file, and make sure you're giving it a file stream rather than a
 memory stream. If you're using the git_unix.c startup file, just make sure\r
 USE_MMAP isn't defined.\r
 \r
-1-byte and 2-byte local variables are not implemented yet. This means git can't\r
-currently play games created with the Superglus system. This will be fixed at\r
-some point.\r
+1-byte and 2-byte local variables are not implemented. This means git can't\r
+play games created with old versions of the Superglus system. As these small\r
+local variables now deprecated, it is unlikely that this will be fixed.\r
 \r
 In the search opcodes, direct keys don't work unless they're exactly 4 bytes\r
 long.\r
@@ -191,6 +192,12 @@ also to Eliuk Blau for tracking down bugs in the memory management opcodes.
 \r
 * Version History\r
 \r
+1.2.9 2011-08-28  Fixed a bug in glkop.c dispatching, to do with optional\r
+                  array arguments, following a similar fix in Glulxe.\r
+                  Glk array and string operations are now checked for memory\r
+                  overflows (though not for ROM writing), following a similar\r
+                  fix in Glulxe.\r
+\r
 1.2.8 2010-08-25  Fixed a problem with 'undo' when compiled as 64 bit,\r
                   contributed by Ben Cressey.\r
                   Fixed a sign problem for the @fceil opcode, following a\r
@@ -267,3 +274,4 @@ also to Eliuk Blau for tracking down bugs in the memory management opcodes.
                   Added gitWithStream() as a workaround for xglk\r
 \r
 1.0   2003-10-18  First public release\r
+\r