home *** CD-ROM | disk | FTP | other *** search
/ ftp.lokigames.com / ftp.lokigames.com.zip / ftp.lokigames.com / open-source / setup / README next >
Text File  |  2001-01-17  |  4KB  |  99 lines
  1.  
  2. The Loki Setup Installer 1.5.8
  3. Written by Sam Lantinga and StΘphane Peter
  4. ------------------------------------------
  5.  
  6. New since 1.4:
  7.  * Added an uninstall program
  8.  * Details about the product are saved to an XML install database
  9.  
  10. New since 1.3:
  11.  * Added support for multiple operating systems (i.e. FreeBSD)
  12.  * Archive extracting subsystem now uses plugin architecture
  13.  * Improved RPM support
  14.  * Lots of other miscellaneous enhancements and fixes
  15.  
  16. New since 1.2:
  17.  * Added internationalization support
  18.    - German, Spanish, French, Italian and Swedish are included
  19.  * Fixed potential security problem
  20.  * Various pathing fixes and other miscellaneous improvements.
  21.  
  22. New since 1.1:
  23.  * Improved C library detection
  24.  * Support for loading install files from CD-ROM
  25.  * Additional attributes for the binary element
  26.  * Environment variable parsing in the XML file
  27.  * Added some environment variables for shell scripts
  28.  
  29. ------------------------------------------
  30.  
  31. This installer uses an XML description file to describe a package,
  32. and provides both a console and a GTk front-end to install it.
  33.  
  34. The installer requires libxml 1.4.0 to parse the XML configuration,
  35. and libglade 0.7 to dynamically load the GTk user interface definition.
  36. Source archives for these libraries can be found in ./libs, and newer
  37. versions may also work.  You should only install static versions of
  38. these libraries, so they will not be required on the user systems.
  39.  
  40. Building the installer:
  41. Type 'make; make install'
  42. This builds a static version of the console installer, and a dynamically
  43. linked version of the GUI installer, and installs them in the appropriate
  44. CD-image subdirectory for this architecture and version of libc.
  45.  
  46. The image subdirectory contains a set of files that you can copy to your
  47. CD image, and modify for the game you are distributing.
  48.  
  49. CD-ROM install file layout:
  50.  
  51. setup.sh    (A shell script to run the correct setup binary)
  52. setup.data/
  53.    setup.xml            (XML file defining the install options)
  54.    setup.glade          (XML file defining the GTk UI)
  55.    splash.xpm           (Optional splash image for the GTk UI)
  56.    bin/
  57.    bin/<OS>/<arch>/setup            (Statically linked console version)
  58.    bin/<OS>/<arch>/<libc>/setup.gtk    (Dynamically linked GTk version)
  59.  
  60. autorun.inf             (Windows CD autorun file that runs win32/autorun.exe)
  61. win32/
  62.    autorun.exe          (Win32 program that starts up explorer on REAMDE.htm)
  63.    README.htm           (An HTML README file for people running Windows)
  64. bin/
  65. bin/<arch>/*
  66. bin/<arch>/<libc>/*     (Directories holding the binaries for the program)
  67.  
  68. --
  69. You should edit the setup.data/setup.xml file to match your product,
  70. and add a new splash.xpm which will be displayed during the install.
  71. There is documentation for the XML setup specification in README.xml
  72.  
  73. Make sure to copy over the setup.glade file in your setup.data directory
  74. every time you update 'setup', because the interface definition may
  75. change between revisions and be incompatible with earlier versions.
  76.  
  77. The binaries for your product are expected to be in bin/<OS>/<arch>/<libc>/
  78. on the CD.  The appropriate binary for the current architecture will
  79. be chosen at install time.  The <libc> portion of the path is optional.
  80. For example, if your binary is called 'rt2', you could have both x86
  81. and PPC versions for Linux as:
  82.     bin/Linux/x86/glibc-2.1/rt2
  83.     bin/Linux/ppc/rt2
  84. and the appropriate binary would be chosen.
  85.  
  86. The install process creates an uninstall script in the install directory
  87. which can be run when the user wants to uninstall the product.
  88.  
  89. Make sure you have included installers for the supported architectures
  90. on your CD!  We have included x86, ppc, alpha, and sparc64 binaries for
  91. this version of the installer.
  92.  
  93. Also included is Stephane Peter's self-extracting archive script in
  94. the makeself subdirectory.  We use this at Loki to generate patches.
  95.  
  96. Play with it, and enjoy!
  97.  
  98. -- Sam Lantinga, Lead Programmer, Loki Entertainment Software
  99.