summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README42
1 files changed, 21 insertions, 21 deletions
diff --git a/README b/README
index 8906709..4d60614 100644
--- a/README
+++ b/README
@@ -8,15 +8,13 @@ flex can be found at:
http://flex.sourceforge.net/
-Bug reports should be submitted using the SourceForge Bug Tracker for
-flex at:
-
-http://sourceforge.net/tracker/?group_id=97492&atid=618177
-
The flex codebase is kept in git at:
https://github.com/westes/flex
+Bugs and pull requests should be filed against flex using github's
+issue tracker and pull request facilities.
+
There are several mailing lists available as well:
flex-announce@lists.sourceforge.net - where posts will be made
@@ -35,24 +33,15 @@ http://sourceforge.net/mail/?group_id=97492
The flex distribution contains the following files which may be of interest:
README - This file.
-
NEWS - current version number and list of user-visible changes.
-
INSTALL - basic installation information.
-
ABOUT-NLS - description of internationalization support in flex.
-
COPYING - flex's copyright and license.
-
doc/ - user documentation.
-
examples/ - containing examples of some possible flex scanners and a
-few other things. See the file examples/README for more details.
-
+ few other things. See the file examples/README for more details.
TODO - outstanding bug reports, desired features, etc.
-
tests/ - regression tests. See TESTS/README for details.
-
po/ - internationalization support files.
You need the following tools to build flex from the maintainer's
@@ -62,13 +51,24 @@ compiler suite - flex is built with gcc
bash, or a good Bourne-style shell
m4 - m4 -p needs to work; GNU m4 and a few others are suitable
GNU bison; to generate parse.c from parse.y
-autoconf 2.69; for handling the build system
-automake 1.12.2; for Makefile generation
-gettext 0.18; fori18n support
-help2man 1.36; to generate the flex man page
+autoconf; for handling the build system
+automake; for Makefile generation
+gettext; for i18n support
+help2man; to generate the flex man page
tar, gzip, etc.; for packaging of the source distribution
-GNU texinfo 498; to build and test the flex manual
-GNU indent 2.8; for indenting the flex source the way we want it done
+
+GNU texinfo; to build and test the flex manual. Note that if you want
+to build the dvi/ps/pdf versions of the documentation you will need
+texi2dvi and related programs, along with a sufficiently powerful
+implementation of \TeX to process them. See your operating system
+documentation for how to achieve this. The printable versions of the
+manual are not built unless specifically requested, but the targets
+are included by automake.
+
+GNU indent; for indenting the flex source the way we want it done
+
+In cases where the versions of the above tools matter, the file
+configure.ac will specify the minimum required versions.
Once you have all the necessary tools installed, life becomes
simple. To prepare the flex tree for building, run the script: