Commit 1c36e649 authored by Louis-Nol Pouchet's avatar Louis-Nol Pouchet
Browse files

2005-10-17 Louis-Noel Pouchet <louis-noel.pouchet@lrde.epita.fr>

	* doc/NEWS.txt: Update. Add licence information.
	* doc/README.txt: Update. Merge with INSTALL.txt.
	
	* AUTHORS: Update. Merge with CONTRIBUTORS.
	* THANKS: Update.

	* INSTALL: New. Default INSTALL file.

	* NOTICE
	* CONTRIBUTORS
	* doc/INSTALL.txt: Delete.

	* Makefile.am,
	* doc/Makefile.am: Update accordingly.
parent 4d8f9928
The Vaucanson Group consists of:
===============
Permanent staff
===============
* Jacques Sakarovitch sakarovitch@enst.fr
- Project manager,
- Theoritical mentor.
* Sylvain Lombardy lombardy@liafa.jussieu.fr
* Thomas Claveirole thomas.claveirole@lrde.epita.fr
* Loic Fosse loic.fosse@lrde.epita.fr
* Raphael Poss raphael.poss@lrde.epita.fr
- Project manager,
- Implementation of crucial algorithms.
* Akim Demaille akim@freefriends.org
- Project manager.
* Sylvain Peyronnet sylvain.peyronnet@lrde.epita.fr
- Project manager.
==================
Year 2003 students
==================
* Yann Regis-Gianas yann.regis-gianas@lrde.epita.fr
- Initial code and releases up to 0.4,
- Everything else.
* Raphael Poss raphael.poss@lrde.epita.fr
- Initial code and releases up to 0.4,
- Lots of code rewriting and optimization,
- Vaucanswig,
- Code maintenance.
==================
Year 2004 students
==================
* Maxime Rey maxime.rey@lrde.epita.fr
- Mical.
==================
Year 2005 students
==================
* Thomas Claveirole thomas.claveirole@lrde.epita.fr
- Lots of code maintenance,
- Release manager for Vaucanson 0.5, 0.6 and 0.6.1,
- New rational expression parser,
- Clean first XML code,
- Demo writing,
- One derivative algorithm on rational expression,
- Algorithms writing,
- Lots of cleaning and bug fixes.
* Loic Fosse loic.fosse@lrde.epita.fr
- Code maintenance,
- New automata construction,
- Rational expression expander,
- Many derivative algorithms on rational expression,
- Heavy work on algorithms,
- Many bug fixes.
* Valentin David valentin.david@lrde.epita.fr
- First XML code.
==================
Year 2006 students
==================
* Sarah O'Connor sarah.o-connor@lrde.epita.fr
- Improvement of transducers on Rat(B*),
- Implementation of free monoid product transducers,
- Algorithms dedicated to transducers.
* Louis-Noel Pouchet louis-noel.pouchet@lrde.epita.fr
* Florent Terrones florent.terrones@lrde.epita.fr
- Release manager for Vaucanson 0.7 and 0.7.1,
- New XML I/O system including new XSD grammar,
- Code maintenance,
- Misc algorithms,
- Many bug fixes.
==================
Year 2007 students
==================
* Robert Bigaignon robert.bigaignon@lrde.epita.fr
- Misc algorithms in [fmp]-transducers,
- Heuristic implementations for state elimination algorithm,
- Bug fixes.
* Michael Cadilhac michael.cadilhac@lrde.epita.fr
- Graph re-implementation,
- Help in packaging,
- Bench suite,
- Misc algorithms fixes and rewriting.
* Florent Terrones florent.terrones@lrde.epita.fr
- Broken Derived terms algorithm,
- New XML I/O system,
- Bug fixes.
This package was written by and with the assistance of:
* Jacques Sakarovitch sakarovitch@enst.fr
- Project manager,
- Theoritical mentor.
* Sylvain Lombardy lombardy@liafa.jussieu.fr
- Project manager,
- Implementation of crucial algorithms.
* Yann Regis-Gianas yann.regis-gianas@lrde.epita.fr
- Initial code and releases up to 0.4,
- Everything else.
* Raphael Poss raphael.poss@lrde.epita.fr
- Initial code and releases up to 0.4,
- Lots of code rewriting and optimization,
- Vaucanswig,
- Code maintenance.
* Maxime Rey maxime.rey@lrde.epita.fr
- Mical.
* Thomas Claveirole thomas.claveirole@lrde.epita.fr
- Lots of code maintenance,
- Release manager for Vaucanson 0.5, 0.6 and 0.6.1,
- New rational expression parser,
- Clean first XML code,
- Demo writing,
- One derivative algorithm on rational expression,
- Algorithms writing,
- Lots of cleaning and bug fixes.
* Loic Fosse loic.fosse@lrde.epita.fr
- Code maintenance,
- New automata construction,
- Rational expression expander,
- Many derivative algorithms on rational expression,
- Heavy work on algorithms,
- Many bug fixes.
* Valentin David valentin.david@lrde.epita.fr
- First XML code.
* Sarah O'Connor sarah.o-connor@lrde.epita.fr
- Improvement of transducers on Rat(B*),
- Implementation of free monoid product transducers,
- Algorithms dedicated to transducers.
* Louis-Noel Pouchet louis-noel.pouchet@lrde.epita.fr
- New XML I/O system,
- Code maintenance,
- Misc algorithms,
- Release manager for Vaucanson 0.7 and 0.7.1.
* Florent Terrones florent.terrones@lrde.epita.fr
- Broken Derived terms algorithm,
- New XML I/O system,
- Bug fixes.
* Robert Bigaignon robert.bigaignon@lrde.epita.fr
- Misc algorithms in [fmp]-transducers,
- Heuristic implementations for state elimination algorithm,
- Bug fixes.
* Michael Cadilhac michael.cadilhac@lrde.epita.fr
- Graph re-implementation,
- Help in packaging,
- Bench suite,
- Misc algorithms fixes and rewriting,
- Test suite fixes.
* Akim Demaille akim@freefriends.org
- Help in packaging.
2005-10-17 Louis-Noel Pouchet <louis-noel.pouchet@lrde.epita.fr>
* doc/NEWS.txt: Update. Add licence information.
* doc/README.txt: Update. Merge with INSTALL.txt.
* AUTHORS: Update. Merge with CONTRIBUTORS.
* THANKS: Update.
* INSTALL: New. Default INSTALL file.
* NOTICE,
* CONTRIBUTORS,
* doc/INSTALL.txt: Delete.
* Makefile.am,
* doc/Makefile.am: Update accordingly.
2005-10-17 Louis-Noel Pouchet <louis-noel.pouchet@lrde.epita.fr>
 
* src/demos/automaton_library/divkbaseb.cc: Fix the name of the
......
Installation Instructions
*************************
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
Software Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
==================
These are generic installation instructions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. (Caching is
disabled by default to prevent problems with accidental use of stale
cache files.)
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'. You only need
`configure.ac' if you want to change it or regenerate `configure' using
a newer version of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that the
`configure' script does not know about. Run `./configure --help' for
details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not support the `VPATH'
variable, you have to compile the package for one architecture at a
time in the source code directory. After you have installed the
package for one architecture, use `make distclean' before reconfiguring
for another architecture.
Installation Names
==================
By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PREFIX'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PREFIX', the package will
use PREFIX as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=DIR' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' cannot figure out automatically,
but needs to determine by the type of machine the package will run on.
Usually, assuming the package is built to be run on the _same_
architectures, `configure' can figure that out, but if it prints a
message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the `--target=TYPE' option to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share, you
can create a site shell script called `config.site' that gives default
values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script). Here is a another example:
/bin/bash ./configure CONFIG_SHELL=/bin/bash
Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
configuration-related scripts to be executed by `/bin/bash'.
`configure' Invocation
======================
`configure' recognizes the following options to control how it operates.
`--help'
`-h'
Print a summary of the options to `configure', and exit.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
......@@ -4,7 +4,7 @@
# $Id$
SUBDIRS = include doc src
EXTRA_DIST = CONTRIBUTORS NOTICE debian vaucanson.spec svn-revision
EXTRA_DIST = debian vaucanson.spec svn-revision
CLEANFILES = svn-revision
###
......@@ -42,7 +42,7 @@ dist-hook:
$(distdir)/src/demos/transducers/u1.xml \
$(distdir)/src/demos/transducers/t1.xml
cp $(srcdir)/doc/README.txt $(distdir)/README
cp $(srcdir)/doc/INSTALL.txt $(distdir)/INSTALL
cp $(srcdir)/doc/NEWS.txt $(distdir)/NEWS
rm -rf `find $(distdir)/debian -name .svn`
###
......
Vaucanson, a generic library for finite state machines.
Copyright (C) 2001, 2002, 2004, 2005 The Vaucanson Group.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
The Vaucanson Group consists of people listed in the `AUTHORS' file.
Contact: vaucanson@lrde.epita.fr.
Many thanks to the following people for their help:
* Akim Demaille akim@freefriends.org
* Alexandre Duret-Lutz duret_g@epita.fr
* Pierre-Yves Strub strub_p@epita.fr
* Nicolas Stroppa stroppa@enst.fr
* Olivier Gournet gourne_o@lrde.epita.fr
=========================================
Installation instructions for Vaucanson
=========================================
:Date: 2005-01-15
Installation instructions for Vaucanson_, a C++ generic library for
weighted finite state machine. See also the file ``README``.
.. _Vaucanson: http://www.lrde.epita.fr/vaucanson
.. contents::
Installation
============
To install Vaucanson on your system, type in the classical sequence at
the command prompt::
./configure
make sanity-check
make check ([1])
make install (as root)
Note that an installation is specific to the compiler used to install
it. Indeed, the call to ``./configure`` enables some workarounds and,
consequently, users must compile with the same compiler to avoid
compatibility problems.
[1]: Optional: check the whole library. Note that this process takes
about 1.5 Go of free space (memory swap included) and several hours.
Additional features
-------------------
There is a Python interpreter in the package. It is disabled by
default because its compilation takes several hours. If you have time
to spare, use instead::
./configure --enable-vaucanswig
There is an XML I/O subsystem in the library. It is enabled by
default, but requires a working installation of another software
package called Xerces-C++. If you do not have this package, or if you
do not want to use XML I/O in Vaucanson, you can use::
./configure --disable-xml
Tweaking compilation options
----------------------------
Use ``CXXFLAGS_DEBUG`` or ``CXXFLAGS_OPTIMIZE`` to pass debug or optimization
flags, not ``CXXFLAGS``. For example::
./configure CXXFLAGS_DEBUG='-fstack-check -fbounds-check -ggdb'
This is because Vaucanson tries to use some particular default flags
with some specific compilers such as GCC or ICC. Using ``CXXFLAGS``
conflicts with those specific flags; ``CXXFLAGS_DEBUG`` and
``CXXFLAGS_OPTIMIZE`` override these default flags.
Requirements
============
Vaucanson was tested with the `GNU C++ Compiler (GCC)`_ version
3.[234], and should work with ICC_ 8.1. The code is written in
respect to the ISO-IEC 14882 (ISO C++) standard to permit a higher
portability in the future.
.. _GNU C++ Compiler (GCC): http://gcc.gnu.org/
.. _ICC: http://www.intel.com/software/products/compilers/
Moreover, high verbose mode of the testing suites uses the AT&T dot
format to save automaton in a human readable file. Use Graphviz_ to
visualize these .dot files.
.. _Graphviz: http://www.research.att.com/sw/tools/graphviz/
If you want to use the XML I/O system, you will need the Apache
`Xerces-C++`_ library version 2.3 or above.
.. _Xerces-C++: http://xml.apache.org/xerces-c/
Licence
=======
Vaucanson is released under the GNU General Public Licence. See the
file ``COPYING`` for details.
......@@ -15,10 +15,9 @@ ref.tar.gz: doc.doxy.in
MAINTAINERCLEANFILES = ref
dist_doc_DATA += README.pdf README.tex README.html \
INSTALL.pdf INSTALL.tex INSTALL.html \
FAQ.pdf FAQ.tex FAQ.html \
NEWS.pdf NEWS.tex NEWS.html
EXTRA_DIST = README.txt INSTALL.txt FAQ.txt NEWS.txt
EXTRA_DIST = README.txt FAQ.txt NEWS.txt
MAINTAINERCLEANFILES += $(dist_doc_DATA)
......@@ -63,7 +63,7 @@ follows::
.. _Vaucanson-XML: http://vaucanson.lrde.epita.fr/VaucansonXML
- This version of Vaucanson is released under the GNU General Public Licence.
Vaucanson 0.7 May 17, 2005
==========================
......@@ -190,6 +190,10 @@ Vaucanson 0.7 May 17, 2005
this expected optimisation.
- This version of Vaucanson is released under the GNU Lesser General Public
Licence.
Vaucanson 0.6.1 October 26, 2004
================================
......@@ -242,6 +246,9 @@ Vaucanson 0.6.1 October 26, 2004
description of ``expand()`` can be found below, in the description
of Vaucanson 0.6.
- This version of Vaucanson is released under the GNU Lesser General Public
Licence.
Vaucanson 0.6 July 18, 2004
===========================
......@@ -409,6 +416,10 @@ Vaucanson 0.6 July 18, 2004
may be needed in ``tools/usual_macros.hh``.
- This version of Vaucanson is released under the GNU Lesser General Public
Licence.
Vaucanson 0.5 March 24, 2004
============================
......@@ -522,6 +533,9 @@ Vaucanson 0.5 March 24, 2004
The minimization algorithm named ``minimization_moore()`` has been
rewritten. It should be more readable and more reliable now.
- This version of Vaucanson is released under the GNU Lesser General Public
Licence.
Vaucanson 0.4 October 29, 2003
==============================
......@@ -540,6 +554,9 @@ Vaucanson 0.4 October 29, 2003
- Addition of a generic search algorithm able to skip characters in
the input stream.