README

   1 Welcome to Inform!
   2 ******************
   3
   4 Inform is an Interactive Fiction (text adventure) game compiler -- it takes
   5 source code you write and turns it into a game data file which is then
   6 played using an 'interpreter'.  There are several interpreters available
   7 which can play Inform games on different machines (e.g. frotz, jzip) -- you
   8 can probably obtain one from the same place you got this package.
   9
  10 Inform was originally written by Graham Nelson, and you are free to
  11 redistribute it under certain conditions -- see the file COPYING for
  12 details.
  13
  14 What's in this distribution?
  15 ============================
  16
  17 The following subdirectories are included in the package:
  18
  19     src         source code for the Inform program
  20     lib         Inform library files
  21     include     selection of useful include files
  22     manual      the online Designer's Manual, in HTML format
  23     demos       some Inform demo games (including the classic 'advent')
  24     tutor       some Inform tutorial files
  25     docs        internal Inform documentation and release notes
  26     contrib     other contributed Inform stuff
  27
  28 How do I install it?
  29 ====================
  30
  31 See the file called INSTALL for detailed instructions.  But basically, it
  32 boils down to...
  33
  34     ./configure
  35     make
  36     make install
  37
  38 This will install the following (assuming default installation):
  39
  40     Inform executable in /usr/local/bin
  41     Inform library modules in /usr/local/share/inform/VERSION/module
  42     Inform include files in /usr/local/share/inform/VERSION/include
  43     HTML Designer's Manual in /usr/local/share/inform/manual
  44
  45 OK, it's installed.  Now what?
  46 ==============================
  47
  48 Now you want to read the online Designer's Manual.  Or, alternatively, you
  49 could start with one of the tutorials in the tutor directory.  After that,
  50 you're all set to write an IF game!  Yay!
  51
  52 Troubleshooting
  53 ===============
  54
  55 If you have any problems with anything, contact the relevant person
  56 listed in the AUTHORS file.  If you're not sure who that is, contact me
  57 instead, at the address at the end of this file.
  58
  59 The Interactive Fiction archive
  60 ===============================
  61
  62 There's a good chance that you got this package from the IF archive, or one
  63 of its mirrors.  But if you didn't, you might like to check it out:
  64
  65     http://www.ifarchive.org
  66
  67 It has lots of great things: games, hints, solutions, authoring systems
  68 (like this one), programs for playing the games, tools for making maps, and
  69 stuff about the late, great Infocom.
  70
  71 There are also more resources for programming with Inform, including a
  72 version of the Inform Designer's Manual suitable for printing.  See the
  73 stuff in the programming/inform6 subdirectory.
  74
  75 The Inform maintainers
  76 ======================
  77
  78 An active community of Inform maintainers exists to fix bugs, implement new
  79 features and issue new versions of the program.  If you'd like to know
  80 more, or you think you've found a bug, visit them at:
  81
  82     http://inform7.com
  83
  84 About this package
  85 ==================
  86
  87 This package was originally created by Glenn Hutchings to address the
  88 tedium of gathering the program, libraries, and documentation for
  89 several different Unix machines.  It received blessing from Graham
  90 Nelson.  The result is a package that automates the configuration and
  91 installation process.  It should build and install on all Unix, Linux,
  92 and Win32/Cygwin system.
  93
  94 This package is an ideal base for creating pre-compiled packages in the
  95 style of Debian .debs, Redhat .rpms and similar schemes as well as build
  96 trees like FreeBSD ports, NetBSD pkgsrc, and Gentoo portage.
  97
  98 Many people contributed to the contents of this package.  See the file
  99 AUTHORS for more details.
 100
 101 This package is hosted at Github:
 102
 103     https://github.com/DavidGriffith/inform6unix
 104
 105 Feel free to hack on it and send me improvements!
 106
 107 Finally...
 108 ==========
 109
 110 If you have any comments or suggestions (or anything else, for that matter)
 111 feel free to drop me a line.  I am:
 112
 113 David Griffith <dave@661.org>.