Back to westes/flex

README.md

Raw
 1[![Build Status](https://github.com/westes/flex/actions/workflows/build.yml/badge.svg)](https://github.com/westes/flex/actions/workflows/build.yml)
 2
 3
 4This is flex, the fast lexical analyzer generator.
 5
 6flex is a tool for generating scanners: programs which recognize
 7lexical patterns in text.
 8
 9The flex codebase is kept in
10[Git on GitHub.](https://github.com/westes/flex) Source releases of flex with some intermediate files already built can be found on [the github releases page.](https://github.com/westes/flex/releases)
11
12Use GitHub's [issues](https://github.com/westes/flex/issues) and
13[pull request](https://github.com/westes/flex) features to file bugs
14and submit patches.
15
16There are several mailing lists available as well:
17
18* flex-announce@lists.sourceforge.net - where posts will be made
19  announcing new releases of flex.
20* flex-help@lists.sourceforge.net - where you can post questions about
21  using flex
22* flex-devel@lists.sourceforge.net - where you can discuss development
23  of flex itself
24
25Find information on subscribing to the mailing lists or search in the
26archive at: https://sourceforge.net/p/flex/mailman/
27Note: Posting is only allowed from addresses that are subscribed to
28the lists.
29
30The flex distribution contains the following files which may be of
31interest:
32
33* README.md - This file.
34* NEWS - current version number and list of user-visible changes.
35* INSTALL.md - basic installation information.
36* ABOUT-NLS - description of internationalization support in flex.
37* COPYING - flex's copyright and license.
38* doc/ - user documentation.
39* examples/ - containing examples of some possible flex scanners and a
40              few other things. See the file examples/README for more
41              details.
42* tests/ - regression tests. See tests/README for details.
43* po/ - internationalization support files.
44
45---
46
47This file is part of flex.
48
49This code is derived from software contributed to Berkeley by
50Vern Paxson.
51
52The United States Government has rights in this work pursuant
53to contract no. DE-AC03-76SF00098 between the United States
54Department of Energy and the University of California.
55
56Redistribution and use in source and binary forms, with or without
57modification, are permitted provided that the following conditions
58are met:
59
601. Redistributions of source code must retain the above copyright
61   notice, this list of conditions and the following disclaimer.
622. Redistributions in binary form must reproduce the above copyright
63   notice, this list of conditions and the following disclaimer in the
64   documentation and/or other materials provided with the distribution.
65
66Neither the name of the University nor the names of its contributors
67may be used to endorse or promote products derived from this software
68without specific prior written permission.
69
70THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
71IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
72WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
73PURPOSE.