Mercurial > ~dholland > hg > ag > index.cgi

comparison doc/misc/readme.html @ 0:13d2b8934445

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import AnaGram (near-)release tree into Mercurial.
author David A. Holland
date Sat, 22 Dec 2007 17:52:45 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:13d2b8934445
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
2 <HTML>
3 <HEAD>
4 <Title>AnaGram: Read Me</Title>
5 </HEAD>
6
7 <BODY
8 BGCOLOR="#ffffff"
9 BACKGROUND="html/tilbl6h.gif"
10 TEXT="#000000"
11 LINK="#0033CC"
12 VLINK="#CC0033"
13 ALINK="#CC0099"
14 >
15
16 <P align=right>
17 <IMG SRC=html/images/aga6d.gif ALT="AnaGram"><BR>
18 A System for Syntax Directed Programming<BR>
19 Version 2.40<BR>
20 <BR>
21 Copyright &copy; 1993-2002 Parsifal Software<BR>
22 Copyright &copy; 2006, 2007 David A. Holland<BR>
23 All Rights Reserved.
24 </P>
25
26 <H1>Read Me</H1>
27 <P>
28 Welcome to AnaGram 2.40, the first <A HREF=license.html>open
29 source</A> release of AnaGram. Whether you installed AnaGram from
30 source or are reading this from a binary distribution, this file
31 should help you to get started and will point you to the various
32 resources and documentation available.
33 </P>
34
35 <P>
36 A summary of the changes in version 2.40 and 2.01 can be found in
37 <A HREF="whatsnew.html">whatsnew.html</A>.
38 </P>
39
40 <P>
41 Release notes for the current build can be found in
42 <A HREF="buildnotes.html">buildnotes.html</A>.
43 </P>
44
45 <H2>Requirements</H2>
46 <P>
47 AnaGram requires approximately five megabytes of disk space for a full
48 binary install. Building from source requires about fifty megabytes of
49 disk space.
50 </P>
51
52 <P>
53 The Windows version of AnaGram requires a Win32 platform (Windows NT,
54 2000, XP, etc., or Win95/98/ME) running on a conventional IA32
55 architecture processor. The Unix version of AnaGram should run on any
56 reasonably standards-compliant Unix-like OS, such as Linux, MacOS X,
57 FreeBSD, or NetBSD.
58 </P>
59
60 <P>
61 Compiling the Windows version from source requires the IBM Visual Age
62 C++ for Windows version 3.5 compiler and its class library. This must
63 at present be done from a Unix host using Wine. Any recent version of
64 Wine should serve.
65 </P>
66
67 <P>
68 Compiling the Unix version from source requires the GNU C++ compiler,
69 g++. At present no GUI exists for the Unix version and so no GUI
70 libraries are required. We expect AnaGram to be runnable on any
71 reasonable 32-bit or 64-bit hardware platform.
72 </P>
73
74 <P>
75 Further information on compiling from source is included with the
76 AnaGram source distribution, in the subdirectory <TT>doc/install</TT>.
77 </P>
78
79 <P>
80 To make use of AnaGram's output you need a C or C++ compiler.
81 </P>
82
83 <H2>Installation</H2>
84 <P>
85 To install the Windows binary distribution of AnaGram, unzip the zip
86 file (ag240.zip) into a convenient directory. If you use PKUNZIP, be
87 sure to use the -d option to preserve the directory structure.
88 </P>
89
90 <P>
91 To install AnaGram from source, consult the installation instructions
92 found in the <tt>doc/install</tt> subdirectory of the AnaGram source
93 distribution.
94 </P
95
96 <P>
97 If for some reason disk space is tight, you can prune everything but
98 the executables (<TT>ag.exe</TT> and <TT>agcl.exe</TT>, or on Unix
99 <TT>ag</TT> and <TT>agcl</TT>) and the DLL (<TT>ag1.dll</TT>, Windows
100 versions only). These must be placed in a single directory. Note that
101 the supplementary files <TT>AnaGram.cgb</TT> and <TT>AnaGram.hlp</TT>
102 no longer exist as of AnaGram 2.40. Also note that non-GUI builds do
103 not install the <TT>ag</TT> executable, only <TT>agcl</TT>.
104 </P>
105
106 <P>
107 If you run the original AnaGram 2.0 after running a later version
108 (whether AnaGram 2.01, 2.40, or some later version) you will get a
109 message box on startup that says, "Error initializing from registry."
110 You may safely ignore this message in this situation.
111 </P>
112
113 <H2>Documentation</H2>
114 <P>
115 AnaGram comes with a complete manual, the
116 <A HREF=usersguide.pdf>User's Guide</A>, in PDF format.
117 This is equivalent to the hardcopy manual distributed with earlier
118 releases of AnaGram. There are also supplements to the manual
119 describing the new features in <A HREF=mansupp-201.html>AnaGram 2.01</A>
120 and in <A HREF=mansupp-240.html>AnaGram 2.40</A>.
121 </P>
122
123 <P>
124 Additionally, AnaGram includes <A HREF=html/index.html>supplementary
125 documentation</A> in HTML format; this includes a Getting Started
126 guide, documentation for the examples included with AnaGram, and some
127 further topics mainly condensed from the User's Guide, provided here
128 for your convenience.
129 </P>
130
131 <P>
132 Finally, AnaGram's user interface includes a complete online help
133 system. You can <A HREF=help.html>read the help from outside
134 AnaGram</A>; within AnaGram, you can access the help by pressing F1,
135 or by selecting Help Topics from the Help menu on the AnaGram control
136 panel. The Help menu also links to <A HREF=help.html#Using_Help>Using
137 Help</A>, a guide to the features of the online help system. The help
138 within AnaGram is fully context-sensitive and supports hypertext
139 linkages, which you can follow by clicking on links or by using the
140 right mouse button.
141 </P>
142
143 <!--
144 <H2>Support and Bug Reports</H2>
145 XXX write this
146 -->
147
148 <H2>Further Resources</H2>
149 <P>
150 For more information about AnaGram and about formal parsing, visit
151 <A HREF=http://www.parsifalsoft.com>http://www.parsifalsoft.com</A>.
152 </P>
153
154 <BR>
155 <P>
156 <I>
157 This product includes software developed by Parsifal Software,
158 Jerome T. Holland, and their contributors.
159 </I>
160 </P>
161
162 <!--
163 Note: if we link against gtk2, which uses freetype2, we may need to
164 stick a freetype2 credit notice here even though we don't use
165 freetype2 directly, because its license is a little odd.
166 -->
167
168 </BODY>
169 </HTML>