view doc/misc/readme.html @ 2:4b08ee1ecb99

Adjust install notes to clarify that Wine applies only to the Windows build. (Thanks to Perry Metzger for test-driving.)
author David A. Holland
date Sun, 26 Apr 2009 17:58:26 -0400
parents 13d2b8934445
children
line wrap: on
line source

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<Title>AnaGram: Read Me</Title>
</HEAD>

<BODY
  BGCOLOR="#ffffff"
  BACKGROUND="html/tilbl6h.gif"
  TEXT="#000000"
  LINK="#0033CC"
  VLINK="#CC0033"
  ALINK="#CC0099"
>

<P align=right>
<IMG SRC=html/images/aga6d.gif ALT="AnaGram"><BR>
A System for Syntax Directed Programming<BR>
Version 2.40<BR>
<BR>
Copyright &copy; 1993-2002 Parsifal Software<BR>
Copyright &copy; 2006, 2007 David A. Holland<BR>
All Rights Reserved.
</P>

<H1>Read Me</H1>
<P>
Welcome to AnaGram 2.40, the first <A HREF=license.html>open
source</A> release of AnaGram.  Whether you installed AnaGram from
source or are reading this from a binary distribution, this file
should help you to get started and will point you to the various
resources and documentation available.
</P>

<P>
A summary of the changes in version 2.40 and 2.01 can be found in
<A HREF="whatsnew.html">whatsnew.html</A>.
</P>

<P>
Release notes for the current build can be found in
<A HREF="buildnotes.html">buildnotes.html</A>.
</P>

<H2>Requirements</H2>
<P>
AnaGram requires approximately five megabytes of disk space for a full
binary install. Building from source requires about fifty megabytes of
disk space.
</P>

<P>
The Windows version of AnaGram requires a Win32 platform (Windows NT,
2000, XP, etc., or Win95/98/ME) running on a conventional IA32
architecture processor. The Unix version of AnaGram should run on any
reasonably standards-compliant Unix-like OS, such as Linux, MacOS X,
FreeBSD, or NetBSD.
</P>

<P>
Compiling the Windows version from source requires the IBM Visual Age
C++ for Windows version 3.5 compiler and its class library. This must
at present be done from a Unix host using Wine. Any recent version of
Wine should serve.
</P>

<P>
Compiling the Unix version from source requires the GNU C++ compiler,
g++. At present no GUI exists for the Unix version and so no GUI
libraries are required. We expect AnaGram to be runnable on any
reasonable 32-bit or 64-bit hardware platform.
</P>

<P>
Further information on compiling from source is included with the
AnaGram source distribution, in the subdirectory <TT>doc/install</TT>.
</P>

<P>
To make use of AnaGram's output you need a C or C++ compiler.
</P>

<H2>Installation</H2>
<P>
To install the Windows binary distribution of AnaGram, unzip the zip
file (ag240.zip) into a convenient directory. If you use PKUNZIP, be
sure to use the -d option to preserve the directory structure.
</P>

<P>
To install AnaGram from source, consult the installation instructions
found in the <tt>doc/install</tt> subdirectory of the AnaGram source
distribution.
</P

<P>
If for some reason disk space is tight, you can prune everything but
the executables (<TT>ag.exe</TT> and <TT>agcl.exe</TT>, or on Unix
<TT>ag</TT> and <TT>agcl</TT>) and the DLL (<TT>ag1.dll</TT>, Windows
versions only). These must be placed in a single directory. Note that
the supplementary files <TT>AnaGram.cgb</TT> and <TT>AnaGram.hlp</TT>
no longer exist as of AnaGram 2.40. Also note that non-GUI builds do
not install the <TT>ag</TT> executable, only <TT>agcl</TT>.
</P>

<P>
If you run the original AnaGram 2.0 after running a later version
(whether AnaGram 2.01, 2.40, or some later version) you will get a
message box on startup that says, "Error initializing from registry."
You may safely ignore this message in this situation.
</P>

<H2>Documentation</H2>
<P>
AnaGram comes with a complete manual, the
<A HREF=usersguide.pdf>User's Guide</A>, in PDF format.
This is equivalent to the hardcopy manual distributed with earlier
releases of AnaGram. There are also supplements to the manual
describing the new features in <A HREF=mansupp-201.html>AnaGram 2.01</A>
and in <A HREF=mansupp-240.html>AnaGram 2.40</A>.
</P>

<P>
Additionally, AnaGram includes <A HREF=html/index.html>supplementary
documentation</A> in HTML format; this includes a Getting Started
guide, documentation for the examples included with AnaGram, and some
further topics mainly condensed from the User's Guide, provided here
for your convenience.
</P>

<P>
Finally, AnaGram's user interface includes a complete online help
system. You can <A HREF=help.html>read the help from outside
AnaGram</A>; within AnaGram, you can access the help by pressing F1,
or by selecting Help Topics from the Help menu on the AnaGram control
panel. The Help menu also links to <A HREF=help.html#Using_Help>Using
Help</A>, a guide to the features of the online help system. The help
within AnaGram is fully context-sensitive and supports hypertext
linkages, which you can follow by clicking on links or by using the
right mouse button.
</P>

<!--
<H2>Support and Bug Reports</H2>
XXX write this
-->

<H2>Further Resources</H2>
<P>
For more information about AnaGram and about formal parsing, visit
<A HREF=http://www.parsifalsoft.com>http://www.parsifalsoft.com</A>.
</P>

<BR>
<P>
<I>
This product includes software developed by Parsifal Software,
Jerome T. Holland, and their contributors.
</I>
</P>

<!--
Note: if we link against gtk2, which uses freetype2, we may need to
stick a freetype2 credit notice here even though we don't use
freetype2 directly, because its license is a little odd.
-->

</BODY>
</HTML>