README.txt 3.42 KB
Newer Older
1
2
3
4

This is Vaucanson, a C++ generic library for weighted finite state
machine.

5
6
7
8
===========================
 Introduction to Vaucanson
===========================

9
:Date: 2005-06-23
10
11
12

Vaucanson_, a C++ generic library for weighted finite state machine.

13
.. _Vaucanson: http://vaucanson.lrde.epita.fr
14
15
16
17
18
19
20
21

.. contents::


Overview
========

Firstly  initiated by  Jacques  Sakarovitch in  2000,  Vaucanson is  a
22
23
24
project   developed   by    the   Ecole   Nationale   Supérieure   des
Télécommunications  [1]   and  the  EPITA   Research  and  Development
Laboratory (LRDE) [2].
25
26
27
28
29
30
31
32
33
34
35
36
37

.. [1] http://www.enst.fr

.. [2] http://www.lrde.epita.fr

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.

38
39
40
41
Yet,   Vaucanson  is  an   ongoing  development   project.   Therefore
algorithms,  data  structures and  the  general  architecture are  not
totally stable and well tested.

42
43
44
Please send  any question or  comments to ``vaucanson@lrde.epita.fr``,
and bug reports to ``vaucanson-bugs@lrde.epita.fr``.

45

46
47
48
Installation
============

49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
Complete installation procedure can be found in ``doc/INSTALL.txt``.

Here is a quick way to install Vaucanson. Type in this sequence at the
command prompt:

	./configure
	make sanity-check
	make install (as root)

This installation  requires 220  Mo of free  space and takes  about 30
minutes on a modern computer.

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.


Using Vaucanson
===============

We are sorry but we do not provide a documentation of Vaucanson.

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.

76

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
See Also
========

There are other sources of interest in the distribution.

- Headline news about the project can be found in the file ``NEWS`` at
  the root of the source tree.

- Documentation  about the  XML  I/O  subsystem can  be  found in  the
  ``doc/xml`` subdirectory.

- The library  reference manual, generated by Doxygen_,  is located in
  ``doc/ref``. It comes distributed as an archive of HTML files called
  ``ref.tar.gz``.

- Information about  the test suite generation mechanism  can be found
  in the file ``src/tests/test-suites/README``.

.. _Doxygen: http://www.doxygen.org

97
.. [3] http://www.research.att.com/sw/tools/fsm/
98

99
100
101
102
Licence
=======

Vaucanson  is released under  the GNU  Lesser General  Public Licence.
103
See the file ``COPYING`` (at the root of the source tree) for details.
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131


Contacts
========

The team can be  reached by mail at ``vaucanson@lrde.epita.fr``. Snail
mail addresses follow.

* Vaucanson - ENST

  | Jacques Sakarovitch
  | 46, rue Barrault
  | F-75013 Paris
  | France

* Vaucanson - LIAFA

  | Sylvain Lombardy
  | 175, rue du Chevaleret
  | F-75013 Paris
  | France

* Vaucanson - LRDE

  | 24,rue Pasteur
  | Paristalie, batiment X, aile Mistral
  | F-94270 Le Kremlin Bicêtre cedex
  | France