Merge branch 'master' into browser
[projects/chimara/chimara.git] / babel / README
diff --git a/babel/README b/babel/README
new file mode 100644 (file)
index 0000000..b754cab
--- /dev/null
@@ -0,0 +1,74 @@
+Version 0.2b, Treaty of Babel Revision 7\r
+This is the source code for babel, the Treaty of Babel analysis tool.\r
+\r
+Most of this code is (c) 2006 by L. Ross Raszewski\r
+\r
+The following files are public domain:\r
+zcode.c\r
+glulx.c\r
+executable.c\r
+level9.c\r
+magscrolls.c\r
+agt.c\r
+hugo.c\r
+advsys.c\r
+misc.c\r
+alan.c\r
+adrift.c\r
+treaty.h\r
+treaty_builder.h\r
+\r
+The following files are Copyright (C) 1999, 2000, 2002 Aladdin Enterprises:\r
+md5.c\r
+md5.h\r
+\r
+And are used in accordance with their licenses.\r
+\r
+All other files are (c) 2006 by L. Ross Raszewski and are released under\r
+the Creative Commons Attribution2.5 License.\r
+\r
+To view a copy of this license, visit\r
+http://creativecommons.org/licenses/by/2.5/ or send a letter to\r
+\r
+Creative Commons,\r
+543 Howard Street, 5th Floor,\r
+San Francisco, California, 94105, USA.\r
+\r
+\r
+To build babel:\r
+\r
+1. compile all the source files in this directory\r
+2. link them together\r
+3. the end\r
+\r
+For folks who find makefiles more useful than generalizations, there is a\r
+makefile provided for babel.  The makefile is currently configured for\r
+Borland's 32-bit C compiler.  Comment out those lines and uncomment the block\r
+which follows for gcc.\r
+\r
+To compile babel-get, first compile babel, then do the same thing in the\r
+babel-get directory.\r
+\r
+To compile ifiction-aggregate, ifiction-xtract, babel-list, and simple-marry,\r
+first compile babel, then compile the relevant C file in the extras/ directory\r
+(These may rely on #include files from the babel directory, so, for example,\r
+to compile ifiction-aggregate, "gcc -c -I.. ifiction-aggregate.c"), then link the\r
+opbject file to the babel and ifiction libraries (babel.lib and ifiction.lib\r
+under Windows, babel.a and ifiction.a most everywhere else.  eg.\r
+"gcc -o ifiction-aggregate ifiction-aggregate.o ../babel.a ../ifiction.a")\r
+\r
+Babel is intended to accept contributions in the form of treaty modules\r
+as defined by the treaty of babel section 2.3.2.\r
+\r
+These modules should use the declarations made in treaty.h.\r
+The file treaty_builder.h generates a generic framework which simplifies\r
+the task of writing treaty modules.  Its use is not required for treaty\r
+compliance, but it should prove useful.\r
+\r
+Parts of babel are intended for use in other programs.  When adapting\r
+babel's source, the files babel.c, babel_story_functions.c and\r
+babel_ifiction_functions.c will probably not prove useful.  However, you\r
+may wish to use babel_handler, which provides a framework for loading a\r
+story file, selecting the proper treaty modules, and seamlessly handling\r
+blorb-wrapped files.\r
+\r