postgresql/README.git

(This file does not appear in release tarballs.)

In a release or snapshot tarball of PostgreSQL, a documentation file named
INSTALL will appear in this directory.  However, this file is not stored in
git and so will not be present if you are using a git checkout.

If you are using a git checkout, you can view the most recent installation
instructions at:
	http://www.postgresql.org/docs/devel/static/installation.html

Users compiling from git will also need compatible versions of Bison, Flex,
and Perl, as discussed in the install documentation.  These programs are not
needed when using a tarball, since the files they are needed to build are
already present in the tarball.  (On Windows, however, you need Perl anyway.)
Some further editorializing on README.CVS. 2004-03-28 14:09:08 +08:00			`(This file does not appear in release tarballs.)`
Remove HISTORY and INSTALL. Have them generated by the tarball scripts. Add README.CVS to help CVS folks find this information. 2004-03-10 08:28:11 +08:00
Don't generate plain-text HISTORY and src/test/regress/README anymore. Providing this information as plain text was doubtless worth the trouble ten years ago, but it seems likely that hardly anyone reads it in this format anymore. And the effort required to maintain these files (in the form of extra-complex markup rules in the relevant parts of the SGML documentation) is significant. So, let's stop doing that and rely solely on the other documentation formats. Per discussion, the plain-text INSTALL instructions might still be worth their keep, so we continue to generate that file. Rather than remove HISTORY and src/test/regress/README from distribution tarballs entirely, replace them with simple stub files that tell the reader where to find the relevant documentation. This is mainly to avoid possibly breaking packaging recipes that expect these files to exist. Back-patch to all supported branches, because simplifying the markup requirements for release notes won't help much unless we do it in all branches. 2014-02-11 09:48:04 +08:00			`In a release or snapshot tarball of PostgreSQL, a documentation file named`
			`INSTALL will appear in this directory. However, this file is not stored in`
			`git and so will not be present if you are using a git checkout.`

			`If you are using a git checkout, you can view the most recent installation`
			`instructions at:`
Fix doc links in README file to work with new website layout Per report from Colin 't Hart 2013-11-12 19:53:32 +08:00			`http://www.postgresql.org/docs/devel/static/installation.html`
Remove HISTORY and INSTALL. Have them generated by the tarball scripts. Add README.CVS to help CVS folks find this information. 2004-03-10 08:28:11 +08:00
Rename README.CVS to README.git and change references in it. 2010-09-21 18:40:16 +08:00			`Users compiling from git will also need compatible versions of Bison, Flex,`
Fix the makefiles to fail cleanly if Perl is needed but not present. This used to work as intended, but got broken some time ago (a quoted empty string is not an empty string), and got broken some more by the changes to generate ecpg's preproc.y automatically. Given all the unprotected uses of $(PERL) elsewhere, it seems best to make use of the $(missing) script rather than trying to ensure each such use is protected individually. Also fix various bits of documentation that omitted to mention Perl as a requirement for building from a CVS pull. Per a complaint from Robert Haas. 2009-06-23 11:46:00 +08:00			`and Perl, as discussed in the install documentation. These programs are not`
Some further editorializing on README.CVS. 2004-03-28 14:09:08 +08:00			`needed when using a tarball, since the files they are needed to build are`
Fix the makefiles to fail cleanly if Perl is needed but not present. This used to work as intended, but got broken some time ago (a quoted empty string is not an empty string), and got broken some more by the changes to generate ecpg's preproc.y automatically. Given all the unprotected uses of $(PERL) elsewhere, it seems best to make use of the $(missing) script rather than trying to ensure each such use is protected individually. Also fix various bits of documentation that omitted to mention Perl as a requirement for building from a CVS pull. Per a complaint from Robert Haas. 2009-06-23 11:46:00 +08:00			`already present in the tarball. (On Windows, however, you need Perl anyway.)`