]> granicus.if.org Git - flex/commitdiff
update README with better urls and make a copyediting pass as well
authorWill Estes <westes575@gmail.com>
Mon, 13 Aug 2012 20:23:35 +0000 (16:23 -0400)
committerWill Estes <westes575@gmail.com>
Mon, 13 Aug 2012 20:23:35 +0000 (16:23 -0400)
README

diff --git a/README b/README
index c233f1660f3ba36e83414bd4de754957528ae78a..75bc87941c9903802e8d125823d94b44406092c9 100644 (file)
--- a/README
+++ b/README
@@ -8,10 +8,10 @@ flex can be found at:
 
 http://flex.sourceforge.net/
 
-Bug reports should be submitted using the SourceForge Bug Tracker
-facilities which can be found from flex's SourceForge project page at:
+Bug reports should be submitted using the SourceForge Bug Tracker for
+flex at:
 
-http://sourceforge.net/projects/flex
+http://sourceforge.net/tracker/?group_id=97492&atid=618177
 
 There are several mailing lists available as well:
 
@@ -24,36 +24,9 @@ using flex
 flex-devel@lists.sourceforge.net - where you can discuss development of
 flex itself
 
-Note that flex is distributed under a copyright very similar to that of
-BSD Unix, and not under the GNU General Public License (GPL).
+Find information on subscribing to the mailing lists at:
 
-This file is part of flex.
-
-This code is derived from software contributed to Berkeley by
-Vern Paxson.
-
-The United States Government has rights in this work pursuant
-to contract no. DE-AC03-76SF00098 between the United States
-Department of Energy and the University of California.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-
-Neither the name of the University nor the names of its contributors
-may be used to endorse or promote products derived from this software
-without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.
+http://sourceforge.net/mail/?group_id=97492
 
 The flex distribution contains the following files which may be of interest:
 
@@ -77,39 +50,31 @@ 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:
+The flex codebase is kept in git at:
+
+git://flex.git.sourceforge.net/gitrepos/flex/flex
 
-http://sourceforge.net/projects/flex
+for readonly access and:
 
-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.
+ssh://username@flex.git.sourceforge.net/gitrepos/flex/flex
 
-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.
+for read-write access, where "username" is your sourceforge username
+that has ben granted write access to flex's git repository.
 
-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.
+You need the following tools to build flex from the maintainer's
+repository:
 
-compiler suite;  e.g., gcc
-bash or some other fairly robust sh-style shell
+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
-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
+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
 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 texinfo 498;  to build and test the flex manual
 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
@@ -123,3 +88,33 @@ GNU-style configure script to be able to work.
 
 From this point on, building flex follows the usual configure, make,
 make install routine.
+
+This file is part of flex.
+
+This code is derived from software contributed to Berkeley by
+Vern Paxson.
+
+The United States Government has rights in this work pursuant
+to contract no. DE-AC03-76SF00098 between the United States
+Department of Energy and the University of California.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+Neither the name of the University nor the names of its contributors
+may be used to endorse or promote products derived from this software
+without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.
+
+