[ Here is Grany3. The cellular automaton simulator. ]


[ Quick authors reference ]

	Yoann Padioleau <ypadiole@ens.insa-rennes.fr>
		engine, file handling, tools (configure...)

	Guillaume Cottenceau <gcottenc@altern.org>
		graphical interface

	Pascal Garcia <pgarcia@ens.insa-rennes.fr>
		hexagonal algorithms

	Gaetan Le Guelvouit <gaetan@mail.dotcom.com>
		design

	Yacine Zemali <yzemali@ens.insa-rennes.fr>
		contribution to the graphical interface

	Sebastien Crunchant <scruncha@ens.insa-rennes.fr>
		contribution to file handling

	Xavier Michard <xmichard@ens.insa-rennes.fr>
		contribution to file handling


[ Underlying physical theory ]

	Dr. Dominique Deserable <dominique.deserable@insa-rennes.fr>


[ Reason ]

	This piece of software has been developped as part of our degree
	of engineer at Insa Rennes, <http://www.insa-rennes.fr>.


[ Online ]

	temporary-accomodation-page:
		http://altern.org/gcottenc/html/grany.html

	distrib:
		http://altern.org/gcottenc/resource/grany-1.0.0.tar.gz

	online-french-help:
		http://www.multimania.com/granyrules


[ Licence ]

	Copyright (C) 1998-2000 by Y. Padioleau, G. Cottenceau, P. Garcia,
	G. LeGuelvouit, Y. Zemali, S. Crunchant, X. Michard.

	Permission to use, copy, modify, and distribute this software and
	its documentation under the terms of the GNU General Public
	License is hereby granted. No representations are made about the
	suitability of this software for any purpose. It is provided "as is"
	without express or implied warranty. See the GNU General Public
	License	for more details.

	By compiling and running Grany3, you implicitly accept this
	licence. Please read COPYING for more info.


[ Needs ]

	gnu make, egcs >= 1.1 or gcc >= 2.95, gtk+ >= 1.2.6, gtkmm >= 1.2.0


[ Install ]

	Grany will **NOT** compile with gcc 2.7.x or gcc 2.8.x having
	libg++.

	Please read INSTALL for basic installation procedure.

	Rapid dependencies:
	 	GNU make
		A good compiler. Preferably GNU gcc 2.95 or better.
		glib 1.2.3 or better.
		gtk+ 1.2.3 or better.
		gtkmm 1.1.9 or better.

	With this it should be enough. Anyway `./configure' will warn you.

	Not necessary but can be useful for hacking Grany3:
		flex++ and bison++
		GNU gettext
		GNU automake/autoconf

	To make the docs, invoke `./configure' with `--enable-docs'.
	We used Doxygen, and it will generate html + latex + man
	documentation.

	Grany supports customization, please read docs/CUSTOMIZATION


	And - no!, GTK does not mean `The Grany ToolKit', but right `The
	Gimp ToolKit'.


[ Succesfully tested on ]

	1.0.0: i686-pc-linux-gnu, Linux-Mandrake 7.0, gnu/make,
		gcc-2.95.2, gtk+-1.2.6, gtk---1.2.0pre1 [libsigc++-0.8.6]

	0.9.1: i686-pc-linux-gnu, Vine 1.0, gnu/make, egcs-1.1.2,
		gtk+-1.2.3, gtk---1.0.1,

		i686-pc-linux-gnu, Vine 1.0, gnu/make, gcc-2.95,
		gtk+-1.2.3, gtk---1.0.2

		sparc-sunos, Solaris 2.5, gnu/make, egcs-1.1.2,
		gtk+-1.2.3, gtk---1.0.1

	0.9: i686-pc-linux-gnu, Vine 1.0, gnu/make, egcs-1.1.2,
		gtk+-1.2.3, gtk---1.0.1,

		i686-pc-linux-gnu, Vine 1.0, gnu/make,
		gcc-2.95, gtk+-1.2.3, gtk---1.0.2

		sparc-sunos, Solaris 2.5, gnu/make, egcs-1.1.2,
		gtk+-1.2.3, gtk---1.0.1

		alphaev56-unknown-gnu, RedHat 5.2, gnu/make, gcc-2.95,
		gtk+-1.2.3, gtk---1.0.2

		ultrasparc-60, Solaris 2.7, gnu/make, egcs-1.1.2,
		gtk+-1.2.3, gtk---1.0.2


	(usual Solaris 2.x gcc 2.8.0 will *NOT* work because of lack of
	iostream)

	(gcc 2.8.1 with libg++ will *NOT* work because of bad STL)

	doc compiled on i686 using: Doxygen version 0.49-990522, TeX
	(Web2C 7.3.1) 3.14159


	0.1.2: i686-pc-linux-gnu, Vine 1.0, gnu/make gnu/egcs 1.1.2
		gtk+-1.2.3 gtk---1.0.0

	0.1: i586-pc-linux-gnu, RedHat 5.1, gnu/make gnu/egcs 1.1.1
		gtk+-1.2.0 gtk---1.0.0


	Initial demo version: none :)


[ Using ]

	Well if you're not a granular physicist please read docs/BASICS


[ Hacking ]

	We're sorry but for our University we had to write code and
	documentation in french.

	However, I felt that this program could be a good example of GTK--
	so I took the time to translate everything in the interface to
	english - that means both identifiers and comments are now in
	english.

	Sorry, but for the rest of the code (the engine, the files, etc),
	all is still in french...


[ Documentation ]

	Please have a look at docs/README for info about documentation.


[ Shameless autosatisfaction ]

	Lines of code processed by our brains:

		engine:	      9197
		interface:   13217
		console:       504
		figures:      1450
		hexagonal:    9058
		files:	      2373

	That is 35799 lines of pure code, not counting the scripts,
	the test code, the generated parsers/compilers.


[ Bug reports ]

	Send bug reports to <gcottenc@altern.org>