summaryrefslogtreecommitdiff
path: root/README
blob: 13a12bf51866a678053d9312e2ca91184c8f0f52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
This is flex, the fast lexical analyzer.

Read the file "INSTALL" for general installation directives.  Peek near
the beginning of the file "Makefile.in" for special DEFS values.  On most
systems, you can just run the "configure" script and type "make" to build
flex; then "make check" to test whether it built correctly; and if it did,
then "make install" to install it.

If you're feeling adventurous, you can also issue "make bigcheck" (be
prepared to wait a while). You can run the regression tests if you change to
the TESTS/ directory and issue "make" followed by "make check".

Note that flex is distributed under a copyright very similar to that of
BSD Unix, and not under the GNU General Public License (GPL).

Please send bug reports and feedback to help-flex@gnu.org.

The flex distribution contains the following files which may be of interest:

README - This file.

NEWS - user visible changes between the various releases.

INSTALL - basic installation information.

COPYING - flex's copyright and license.

flex.1, flex.texi - user documentation.

RoadMap - notes for developers.

examples/ - containing examples of some possible flex scanners and a
few other things. See the file examples/README for more details.

TODO, to.do/ - outstanding bug reports, desired features, etc.

faqs/ - frequently asked questions.

misc/ - assorted files which may be of interest when building flex on
platforms other than *nix ones. See misc/README for more information.

tests/ - regression tests. See TESTS/README for details.