summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorWill Estes <westes575@gmail.com>2012-08-08 09:10:53 -0400
committerWill Estes <westes575@gmail.com>2012-08-13 06:53:14 -0400
commite8d3df5a9ea532042bd6acb0f3c4bbb20b506e7d (patch)
treeb1937e2604cbd89071eb7cd1caabc3ba5aeb7d87 /README
parent7642bd98aebb62260df923f57b794138dab6f1e7 (diff)
append README.cvs contents to README
Diffstat (limited to 'README')
-rw-r--r--README46
1 files changed, 46 insertions, 0 deletions
diff --git a/README b/README
index 0a6a70c..c233f16 100644
--- a/README
+++ b/README
@@ -77,3 +77,49 @@ TODO - outstanding bug reports, desired features, etc.
tests/ - regression tests. See TESTS/README for details.
po/ - internationalization support files.
+This file gives information regarding the cvs tree of flex. The cvs
+tree of flex contains the files which are under version control by
+the flex maintainers for the flex project.
+
+You can learn about the details of retrieving a copy of the cvs flex
+tree from flex's SourceForge project page at:
+
+http://sourceforge.net/projects/flex
+
+If you are not interested in flex development or you are not in need
+of the latest bleeding-edge features, then the cvs flex tree is
+not for you.
+
+When you get a distribution of flex, a large number of intermediate
+files needed to make building flex easy are included. You don't have
+that in the cvs tree.
+
+You will need various external tools in order to build the distribution. Here is
+a (hopefully complete and correct) list of the required tools. Always get the
+latest version of each tool; we list the versions used in development of
+flex, but the listed versions may not work for you.
+
+compiler suite; e.g., gcc
+bash or some other fairly robust sh-style shell
+GNU bison; to generate parse.c from parse.y
+GNU m4 1.4; required by GNU autoconf (yes, it *must* be GNU m4)
+GNU autoconf 2.60 and GNU automake 1.10; for generating Makefiles etc.
+GNU gettext 0.14.5; for i18n
+flex (latest beta release); for bootstrap of scan.l
+help2man 1.36; to generate the flex man page
+tar, gzip, etc.; for packaging of the source distribution
+GNU texinfo 4.8; to build and test the flex manual
+perl; GNU automake and GNU autoconf now depend on perl to run
+GNU indent 2.8; for indenting the flex source the way we want it done
+
+Once you have all the necessary tools installed, life becomes
+simple. To prepare the flex tree for building, run the script:
+
+$ ./autogen.sh
+
+in the top level of the flex source tree.
+This script calls the various tools needed to get flex ready for the
+GNU-style configure script to be able to work.
+
+From this point on, building flex follows the usual configure, make,
+make install routine.