README

   1 This README resides in the top directory of Shapes.
   2
   3 ===( Introduction )===
   4
   5 Shapes is a functional drawing language.  It is used to produce scalable graphics in the PDF format.  Typically, an illustration is created by typing Shapes source code in a text file, which is then compiled to PDF using the Shapes compiler.
   6
   7
   8 ===( Directory map )===
   9
  10 Important items in this directory include:
  11
  12 o  COPYING -- The GPL licence under which this software is distributed.
  13
  14 o  INSTALL -- (present only if this is a distribution package) a file with installation instructions, corresponding to http://lang-shapes.sourceforge.net/doc/install.html.
  15
  16 o  VERSION -- A brief, manually compiled, change log.
  17
  18 o  doc/ -- documentation, consisting of both sources and tools for producing documentation in various formats.  Documentation in the HTML format can be browsed directly at
  19   http://lang-shapes.sourceforge.net/doc/
  20
  21 o  edit/ -- text editor plug-ins that support editing Shapes programs.
  22
  23 o  examples/ -- example programs.
  24
  25 o  source/ -- sources for the Shapes compiler.
  26
  27 o  resources/ -- files used by the Shapes compiler, such as standard extensions.
  28
  29
  30 ===( Further information )===
  31
  32 On the Shapes homepage,
  33   http://lang-shapes.sourceforge.net/
  34 you will find language documentation, download links, dependencies, how to get involved, and more.