Update references to README files

Most of the README files have been renamed. Refer to the new names.
This commit is contained in:
Jay Berkenbilt 2017-08-22 13:10:47 -04:00
parent dba228452d
commit 6219111ed7
9 changed files with 32 additions and 22 deletions

View File

@ -1,3 +1,13 @@
2017-08-22 Jay Berkenbilt <ejb@ql.org>
* Convert all README files to markdown. Names changed as follows:
- README --> README.md
- README.hardening --> README-hardening.md
- README.maintainer --> README-maintainer.md
- README-what-to-download.txt --> README-what-to-download.md
- README-windows.txt --> README-windows.md
The file README-windows-install.txt remains a text file.
2017-08-21 Jay Berkenbilt <ejb@ql.org> 2017-08-21 Jay Berkenbilt <ejb@ql.org>
* Add support for writing PCLm files. Most of the work was done by * Add support for writing PCLm files. Most of the work was done by

View File

@ -43,7 +43,7 @@ Release Reminders
properly handled. properly handled.
* Remember to avoid using operator[] with std::string or * Remember to avoid using operator[] with std::string or
std::vector. See README.hardening for details. std::vector. See README-hardening.md for details.
* Increment shared library version information as needed (LT_* in * Increment shared library version information as needed (LT_* in
configure.ac) configure.ac)
@ -110,7 +110,7 @@ Release Reminders
* Before releasing, rebuild and test debian package. * Before releasing, rebuild and test debian package.
* Remember to copy README-what-to-download.txt separately onto the * Remember to copy README-what-to-download.md separately onto the
download area. download area.
* Remember to update the web page including putting new documentation * Remember to update the web page including putting new documentation

View File

@ -37,7 +37,7 @@ download.
If you want to build qpdf for Windows yourself with either MINGW or If you want to build qpdf for Windows yourself with either MINGW or
MSVC 2010, you can download this file and extract it inside the MSVC 2010, you can download this file and extract it inside the
qpdf source distribution. Please refer to README-windows.txt in qpdf source distribution. Please refer to README-windows.md in
the qpdf source distribution for additional details. Note that you the qpdf source distribution for additional details. Note that you
need the 2012-06-20 version or later to be able to build qpdf 3.0 need the 2012-06-20 version or later to be able to build qpdf 3.0
or newer. The 2009-10-24 version is required for qpdf 2.3.1 or or newer. The 2009-10-24 version is required for qpdf 2.3.1 or
@ -51,6 +51,6 @@ download.
libary, it includes a README file and some scripts to help you libary, it includes a README file and some scripts to help you
build it for Windows. qpdf was built using a binary distribution of build it for Windows. qpdf was built using a binary distribution of
libjpeg-turbo for Windows. You will also have to provide those. See libjpeg-turbo for Windows. You will also have to provide those. See
README-windows.txt for details. README-windows.md for details.
If you want to build on Windows, please see also README-windows.txt. If you want to build on Windows, please see also README-windows.md.

View File

@ -17,7 +17,7 @@ QPDF depends on the external libraries "zlib" and "jpeg". These are
part of every Linux distribution and are readily available. Download part of every Linux distribution and are readily available. Download
information appears in the documentation. For Windows, you can information appears in the documentation. For Windows, you can
download pre-built binary versions of these libraries for some download pre-built binary versions of these libraries for some
compilers; see README-windows.txt for additional details. compilers; see README-windows.md for additional details.
QPDF requires a C++ compiler that works with STL. Your compiler must QPDF requires a C++ compiler that works with STL. Your compiler must
also support "long long". Almost all modern compilers do. If you are also support "long long". Almost all modern compilers do. If you are
@ -82,7 +82,7 @@ Building from a pristine checkout
When building qpdf from a pristine checkout from version control, When building qpdf from a pristine checkout from version control,
documentation and automatically generated files are not present. documentation and automatically generated files are not present.
Building on Windows from a pristine checkout is not guaranteed to work Building on Windows from a pristine checkout is not guaranteed to work
because of issues running autoconf; see README-windows.txt for how to because of issues running autoconf; see README-windows.md for how to
handle this. For UNIX and UNIX-like systems, you must have some handle this. For UNIX and UNIX-like systems, you must have some
addditional tools installed to build from the source repository. To addditional tools installed to build from the source repository. To
do this, you should run do this, you should run
@ -124,8 +124,8 @@ QPDF is known to build and pass its test suite with mingw (latest
version tested: gcc 4.6.2), mingw64 (latest version tested: 4.7.0) and version tested: gcc 4.6.2), mingw64 (latest version tested: 4.7.0) and
Microsoft Visual C++ 2010, both 32-bit and 64-bit versions. MSYS plus Microsoft Visual C++ 2010, both 32-bit and 64-bit versions. MSYS plus
ActiveState Perl is required to build as well in order to get make ActiveState Perl is required to build as well in order to get make
and other related tools. See README-windows.txt for details on how to and other related tools. See README-windows.md for details on how to
build under Windows, see README-windows.txt. build under Windows, see README-windows.md.
Additional Notes on Build Additional Notes on Build
@ -137,7 +137,7 @@ obeying the compiler specified with configure. This can be enabled by
passing --with-buildrules=buildrules where buildrules corresponds to passing --with-buildrules=buildrules where buildrules corresponds to
one of the .mk files (other than rules.mk) in the make directory. one of the .mk files (other than rules.mk) in the make directory.
This should never be necessary on a UNIX system, but may be necessary This should never be necessary on a UNIX system, but may be necessary
on a Windows system. See README-windows.txt for details. There is a on a Windows system. See README-windows.md for details. There is a
gcc-linux.mk file enable "gcc-linux" build rules, but it is intended gcc-linux.mk file enable "gcc-linux" build rules, but it is intended
to help test the build system; Linux users should build with the to help test the build system; Linux users should build with the
"libtools" rules, which are enabled by default. "libtools" rules, which are enabled by default.

View File

@ -228,7 +228,7 @@ AC_MSG_CHECKING(which build rules to use)
AC_SUBST(BUILDRULES) AC_SUBST(BUILDRULES)
AC_ARG_WITH(buildrules, AC_ARG_WITH(buildrules,
AS_HELP_STRING([--with-buildrules=rules], AS_HELP_STRING([--with-buildrules=rules],
[which build rules to use; see README]), [which build rules to use; see README.md]),
[BUILDRULES=$withval], [BUILDRULES=$withval],
[BUILDRULES=libtool]) [BUILDRULES=libtool])
AC_MSG_RESULT($BUILDRULES) AC_MSG_RESULT($BUILDRULES)

View File

@ -118,7 +118,7 @@ SecureRandomDataProvider::provideRandomData(unsigned char* data, size_t len)
#else #else
# error "Don't know how to generate secure random numbers on this platform. See random number generation in the top-level README" # error "Don't know how to generate secure random numbers on this platform. See random number generation in the top-level README.md"
#endif #endif
} }

View File

@ -1,5 +1,5 @@
#!/bin/sh #!/bin/sh
# This script is used for valgrind testing. See README.maintainer. # This script is used for valgrind testing. See README-maintainer.md.
# Create a suppressions file. This can be updated by running valgrind # Create a suppressions file. This can be updated by running valgrind
# with --gen-suppressions=yes. # with --gen-suppressions=yes.

View File

@ -1,7 +1,7 @@
#!/usr/bin/env perl #!/usr/bin/env perl
# #
# This program creates a source distribution of qpdf. For details, # This program creates a source distribution of qpdf. For details,
# see README.maintainer. # see README-maintainer.md.
# #
require 5.008; require 5.008;

View File

@ -87,7 +87,7 @@
<title>Building and Installing QPDF</title> <title>Building and Installing QPDF</title>
<para> <para>
This chapter describes how to build and install qpdf. Please see This chapter describes how to build and install qpdf. Please see
also the <filename>README</filename> and also the <filename>README.md</filename> and
<filename>INSTALL</filename> files in the source distribution. <filename>INSTALL</filename> files in the source distribution.
</para> </para>
<sect1 id="ref.prerequisites"> <sect1 id="ref.prerequisites">
@ -210,17 +210,17 @@ make
configured. You can also set the value of configured. You can also set the value of
<varname>DESTDIR</varname> during installation to install to a <varname>DESTDIR</varname> during installation to install to a
temporary location, as is common with many open source packages. temporary location, as is common with many open source packages.
Please see also the <filename>README</filename> and Please see also the <filename>README.md</filename> and
<filename>INSTALL</filename> files in the source distribution. <filename>INSTALL</filename> files in the source distribution.
</para> </para>
<para> <para>
Building on Windows is a little bit more complicated. For Building on Windows is a little bit more complicated. For
details, please see <filename>README-windows.txt</filename> in the details, please see <filename>README-windows.md</filename> in the
source distribution. You can also download a binary distribution source distribution. You can also download a binary distribution
for Windows. There is a port of qpdf to Visual C++ version 6 in for Windows. There is a port of qpdf to Visual C++ version 6 in
the <filename>contrib</filename> area generously contributed by the <filename>contrib</filename> area generously contributed by
Jian Ma. This is also discussed in more detail in Jian Ma. This is also discussed in more detail in
<filename>README-windows.txt</filename>. <filename>README-windows.md</filename>.
</para> </para>
<para> <para>
There are some other things you can do with the build. Although There are some other things you can do with the build. Although
@ -2102,7 +2102,7 @@ outfile.pdf</option>
would enable you to use some software-based secure pseudorandom would enable you to use some software-based secure pseudorandom
number generator and to avoid use of whatever the operating system number generator and to avoid use of whatever the operating system
provides. For details on how to do this, please refer to the provides. For details on how to do this, please refer to the
top-level README file in the source distribution and to comments top-level README.md file in the source distribution and to comments
in <filename>QUtil.hh</filename>. in <filename>QUtil.hh</filename>.
</para> </para>
</sect1> </sect1>
@ -3256,7 +3256,7 @@ print "\n";
converts numbers to strings. This is largely invisible to converts numbers to strings. This is largely invisible to
users, but it does trigger a bug in some older versions of users, but it does trigger a bug in some older versions of
mingw-w64's C++ library. See mingw-w64's C++ library. See
<filename>README-windows.txt</filename> in the source <filename>README-windows.md</filename> in the source
distribution if you think this may affect you. The copy of distribution if you think this may affect you. The copy of
the DLL distributed with qpdf's binary distribution is not the DLL distributed with qpdf's binary distribution is not
affected by this problem. affected by this problem.
@ -3677,7 +3677,7 @@ print "\n";
not needed to verify a correct build or port of qpdf. They not needed to verify a correct build or port of qpdf. They
are needed only when changing the actual PDF output generated are needed only when changing the actual PDF output generated
by qpdf. You should enable them if you are making deep by qpdf. You should enable them if you are making deep
changes to qpdf itself. See <filename>README</filename> for changes to qpdf itself. See <filename>README.md</filename> for
details. details.
</para> </para>
</listitem> </listitem>
@ -3686,7 +3686,7 @@ print "\n";
Large file tests are off by default but can be turned on with Large file tests are off by default but can be turned on with
<command>./configure</command> or by setting an environment <command>./configure</command> or by setting an environment
variable before running the test suite. See variable before running the test suite. See
<filename>README</filename> for details. <filename>README.md</filename> for details.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>