Commit 412293f2 authored by Akim Demaille's avatar Akim Demaille
Browse files

Update README.

	* doc/FAQ.txt, doc/README.txt: Update.
	* doc/doc.mk: Don't tolerate warnings.
parent 4ebeefe5
2006-05-31 Akim Demaille <akim@lrde.epita.fr>
Update README.
* doc/FAQ.txt, doc/README.txt: Update.
* doc/doc.mk: Don't tolerate warnings.
2006-05-31 Akim Demaille <akim@lrde.epita.fr>
Include argp for sake on non Glibc architectures.
......
......@@ -2,12 +2,12 @@
Vaucanson_ Frequently Asked Questions
=======================================
:Date: January 2005
:Date: March 2006
Here are answers to different questions you may have while compiling
or using Vaucanson_.
.. _Vaucanson: http://www.lrde.epita.fr/vaucanson
.. _Vaucanson: http://vaucanson.lrde.epita.fr
.. contents::
......@@ -24,11 +24,12 @@ compiler, such as the `GNU C++ Compiler`_ version 3.3 or above.
.. _GNU C++ Compiler: http://gcc.gnu.org
I have a conflit declaration for ``int getopt()``. How to solve it?
-------------------------------------------------------------------
I have a conflit declaration for ``int getopt()``.
--------------------------------------------------
The flag ``HAVE_DECL_GETOPT`` must be set. Compile with ``-DHAVE_DECL_GETOPT``.
To use this flag with the script ``configure``, call it with::
The flag ``HAVE_DECL_GETOPT`` must be set. Compile with
``-DHAVE_DECL_GETOPT``. To use this flag with the script
``configure``, call it with::
configure CPPFLAGS='-DHAVE_DECL_GETOPT'
......@@ -38,15 +39,15 @@ Usage issues
The expression parser behave incorrectly on some expressions
------------------------------------------------------------
For example, expressions with weights such as ``a 2*`` (meaning "the
For example, expressions with weights such as ``a 2*`` (meaning "the
star of ``a`` with weight 2) are not parsed correctly.
Solution: write ``(a 2)*`` instead. This problem is due to the use of
LL parsing, which cannot handle expressions like the example
above. This is a known misfeature, that cannot be corrected without
making the code bigger and slower. Since a very readable, simple
Solution: write ``(a 2)*`` instead. This problem is due to the use of
LL parsing, which cannot handle expressions like the example
above. This is a known misfeature, that cannot be corrected without
making the code bigger and slower. Since a very readable, simple
workaround exists, use it instead.
.. Local Variables:
.. mode: rst
.. End:
......@@ -2,7 +2,7 @@
Introduction to Vaucanson
===========================
:Date: 2005-06-23
:Date: 2006-05-31
Vaucanson_, a C++ generic library for weighted finite state machines.
......@@ -14,10 +14,9 @@ Vaucanson_, a C++ generic library for weighted finite state machines.
Overview
========
Firstly initiated by Jacques Sakarovitch in 2000, Vaucanson is a
project developed by the Ecole Nationale Supérieure des
Télécommunications [1] and the EPITA Research and Development
Laboratory (LRDE) [2].
Initiated by Jacques Sakarovitch in 2000, Vaucanson is a project
developed by the École Nationale Supérieure des Télécommunications [1]
and the EPITA Research and Development Laboratory (LRDE) [2].
.. [1] http://www.enst.fr
......@@ -25,19 +24,19 @@ Laboratory (LRDE) [2].
The goal of this library is to enable the development of C++ programs
in an abstract and general way with, at the same time, a large
specialization power. Indeed, on the one hand, we can write algorithms
working on every automaton with weights over any semirings and with
words from any free monoids. And on the other hand, a particular
algorithm can be specialized for a particular data structure
implementing only a pseudo behaviour.
specialization power. Indeed, on the one hand, we can write
algorithms working on every automaton with weights over any semirings
and with words from any free monoids. And on the other hand, a
particular algorithm can be specialized for a particular data
structure implementing only a pseudo behaviour.
Yet, Vaucanson is an ongoing development project. Therefore
algorithms, data structures and the general architecture are not
totally stable and well tested.
Please send any question or comments to ``vaucanson@lrde.epita.fr``,
and bug reports to ``vaucanson-bugs@lrde.epita.fr``.
Please send any question or comments to vaucanson@lrde.epita.fr, and
report bugs to either our issue tracker http://vaucanson.lrde.org/, or
to vaucanson-bugs@lrde.epita.fr.
Installation
============
......@@ -46,6 +45,7 @@ To install Vaucanson on your system, type in the classical sequence at
the command prompt::
./configure
make
make sanity-check
make check ([1])
make install (as root)
......@@ -63,7 +63,7 @@ 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::
to spare, use::
./configure --enable-vaucanswig
......@@ -74,7 +74,7 @@ do not want to use XML I/O in Vaucanson, you can use::
./configure --disable-xml
To specify a special path for the Xerces-C library, you can use::
To specify a special path for the Xerces-C library::
./configure --with-xerces=/absolute/path/to/xerces
......@@ -86,8 +86,8 @@ For further configure options, type::
Tweaking compilation options
----------------------------
Use ``CXXFLAGS_DEBUG`` or ``CXXFLAGS_OPTIMIZE`` to pass debug or optimization
flags, not ``CXXFLAGS``. For example::
Use ``CXXFLAGS_DEBUG`` or ``CXXFLAGS_OPTIMIZE`` to pass debug or
optimization flags, not ``CXXFLAGS``. For example::
./configure CXXFLAGS_DEBUG='-fstack-check -fbounds-check -ggdb'
......@@ -101,20 +101,22 @@ Requirements
============
Vaucanson was tested with the `GNU C++ Compiler (GCC)`_ version 3.[34]
and 4.0, and should work with ICC_ 9. The code is written in respect
to the ISO-IEC 14882 (ISO C++) standard to permit a higher portability
in the future.
and 4.0, and should work with ICC_ 9. The code is fully compliant
with the ISO C++ standard (ISO-IEC 14882) to permit a higher
portability in the future.
.. _GNU C++ Compiler (GCC): http://gcc.gnu.org/
.. _ICC: http://www.intel.com/software/products/compilers/
A known bug in GCC 4.0.0 for MacOs is supported to make the code
compliant with this specific compiler version, but MacOs users are
encouraged to upgrade their compiler.
A known bug in GCC 4.0.0 for MacOs is supported to make the code
compliant with this specific compiler version, but MacOs users are
encouraged to upgrade their compiler. They should also notice that
their platform allows to select their default compiler using
``gcc_select``. GCC 4.0 is preferred.
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.
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/
......@@ -127,15 +129,12 @@ If you want to use the XML I/O system, you will need the Apache
Using Vaucanson
===============
We are sorry but we do not provide a documentation of the Vaucanson
library.
However Vaucanson comes with several demos. Looking at them is a good
way to see what Vaucanson can do and how it works. Those demos can be
found in the ``src/demos`` directory.
Vaucanson comes with several demos. Looking at them is a good way to
see what Vaucanson can do and how it works. They can be found in the
``src/demos`` directory.
The TAF-Kit (Typed Automata Functions) documentation can be found
as the first chapter of the User's Manual (see ``doc/manual``).
The TAF-Kit (Typed Automata Functions) documentation can be found as
the first chapter of the User's Manual (see ``doc/manual``).
See Also
========
......@@ -162,7 +161,6 @@ There are other sources of interest in the distribution.
.. _Doxygen: http://www.doxygen.org
.. [3] http://www.research.att.com/sw/tools/fsm/
Licence
=======
......@@ -171,14 +169,14 @@ Vaucanson is now released under the GNU General Public Licence. See the
file ``COPYING`` (at the root of the source tree) for details.
Vaucanson was released under the GNU Lesser General Public Licence until
version 0.7.
version 0.7.
Contacts
========
The team can be reached by mail at ``vaucanson@lrde.epita.fr``. Snail
mail addresses follow.
The team can be reached by mail at vaucanson@lrde.epita.fr. Snail mail
addresses follow.
* Vaucanson - ENST
......
......@@ -5,10 +5,10 @@
# because we actually also provide the tex output, so in fact the path
# has the same length: tex -> html.
%.html: %.txt
$(RST2HTML) --input-encoding=iso-8859-1 $< >$@
$(RST2HTML) --halt=warning --input-encoding=iso-8859-1 $< >$@
%.tex: %.txt
$(RST2TEX) --input-encoding=iso-8859-1 $< >$@
$(RST2TEX) --halt=warning --input-encoding=iso-8859-1 $< >$@
share_dir = $(top_srcdir)/doc/share
# Cannot factor here because Automake needs to be able to read
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment