Examples/GIFPlot/README

   1 GIFPlot
   2 =======
   3
   4 To illustrate various SWIG features, the following examples involve
   5 building an interface to a small, but somewhat useful graphics library
   6 for creating 2D and 3D images in the form of GIF files.  The Perl,
   7 Python, Tcl, Java, Ruby etc. directories contain various examples specific to
   8 those languages.
   9
  10 This library was originally developed as part of the SPaSM molecular
  11 dynamics project at Los Alamos National Laboratory.  However, due to
  12 patent enforcement issues related to LZW encoding and a general lack
  13 of time on the part of the author, the library was never officially
  14 released.  On the plus side, a number of people have found it to be a
  15 useful easter egg within the SWIG distribution :-).
  16
  17 <LEGAL>
  18 DUE TO PATENT RESTRICTIONS ON THE LZW COMPRESSION ALGORITHM, THIS
  19 LIBRARY ONLY PRODUCES UNCOMPRESSED GIF FILES.  SO THERE.
  20 </LEGAL>
  21
  22 Building the Library
  23 ====================
  24
  25 In order to run the examples, it is first necessary to build the GIFPlot
  26 C library.  To do this, simply run make:
  27
  28         make
  29
  30 Running the Examples
  31 ====================
  32
  33 Once the library has been built, go to your chosen language directory,
  34 that is, Perl, Python, Tcl, Java, Ruby etc. Each example should have a
  35 README file with a description.
  36
  37 Each example can be compiled using the makefile in each example directory. This
  38 makefile uses the top level makefile in the "Examples" directory of the distribution.
  39 If the example doesn't compile, you will need to adjust the settings in this file.
  40
  41 Documentation
  42 =============
  43
  44 Read the source Luke.   The examples should be pretty much self-explanatory.
  45 The header file Include/gifplot.h contains the full API.
  46
  47 The original documentation for the library can be found online at:
  48
  49           http://www.dabeaz.com/gifplot/index.html
  50
  51
  52 Let me know what you think!
  53 ===========================
  54 If you found this example to be useful, confusing, or otherwise, I would like to know
  55 about it.   Suggestions for improvement are welcome.
  56
  57 -- Dave (dave@dabeaz.com)
  58
  59