Remove misleading manpage.

README.md changes:
- Added a related projects section at the end.
- Added blank line after header where missing.
- Added extra blank line before header to make them easier to spot as plain-text.
- Changed line-length for Contributing section, to make it more readable as plain-text.

CMakeLists.txt

@@ -995,9 +995,6 @@ if(NOT SKIP_INSTALL_HEADERS AND NOT SKIP_INSTALL_ALL)
     install(FILES ${CMAKE_CURRENT_BINARY_DIR}/zconf${SUFFIX}.h
         DESTINATION "${INC_INSTALL_DIR}" RENAME zconf${SUFFIX}.h)
 endif()
-if(NOT SKIP_INSTALL_FILES AND NOT SKIP_INSTALL_ALL)
-    install(FILES zlib.3 DESTINATION "${MAN_INSTALL_DIR}/man3" RENAME zlib${SUFFIX}.3)
-endif()
 if(NOT SKIP_INSTALL_FILES AND NOT SKIP_INSTALL_ALL)
     install(FILES ${ZLIB_PC} DESTINATION "${PKGCONFIG_INSTALL_DIR}")
 endif()

INDEX.md

@@ -32,6 +32,5 @@ Contents
 | uncompr.c        | Decompress a memory buffer                                     |
 | zconf.h.cmakein  | zconf.h template for cmake                                     |
 | zendian.h        | BYTE_ORDER for endian tests                                    |
-| zlib.3           | Man page for zlib                                              |
 | zlib.map         | Linux symbol information                                       |
 | zlib.pc.in       | Pkg-config template                                            |

Makefile.in

@@ -360,9 +360,6 @@ install-static: $(STATICLIB)
 install-libs: install-shared install-static
 	-@if [ ! -d $(DESTDIR)$(man3dir)      ]; then mkdir -p $(DESTDIR)$(man3dir); fi
 	-@if [ ! -d $(DESTDIR)$(pkgconfigdir) ]; then mkdir -p $(DESTDIR)$(pkgconfigdir); fi
-	rm -f $(DESTDIR)$(man3dir)/zlib$(SUFFIX).3
-	cp $(SRCDIR)/zlib.3 $(DESTDIR)$(man3dir)/zlib$(SUFFIX).3
-	chmod 644 $(DESTDIR)$(man3dir)/zlib$(SUFFIX).3
 	rm -f $(DESTDIR)$(pkgconfigdir)/$(PKGFILE)
 	cp $(PKGFILE) $(DESTDIR)$(pkgconfigdir)
 	chmod 644 $(DESTDIR)$(pkgconfigdir)/$(PKGFILE)
@@ -387,14 +384,8 @@ endif
 
 uninstall: uninstall-static uninstall-shared
 	cd $(DESTDIR)$(includedir) && rm -f zlib$(SUFFIX).h zconf$(SUFFIX).h
-	cd $(DESTDIR)$(man3dir) && rm -f zlib$(SUFFIX).3
 	cd $(DESTDIR)$(pkgconfigdir) && rm -f $(PKGFILE)
 
-docs: zlib.3.pdf
-
-zlib.3.pdf: $(SRCDIR)/zlib.3
-	groff -mandoc -f H -T ps $(SRCDIR)/zlib.3 | ps2pdf - zlib.3.pdf
-
 mostlyclean: clean
 clean:
 	@if [ -f $(ARCHDIR)/Makefile ]; then $(MAKE) -C $(ARCHDIR) clean; fi
@@ -432,7 +423,7 @@ distclean: clean
 	grep -v '^#cmakedefine' $(SRCDIR)/zconf.h.in > zconf.h.cmakein &&\
 	touch -r $(SRCDIR)/zconf.h.in zconf.h.cmakein ; fi
 # Cleanup these files if building outside source tree
-	@if [ ! -f zlib.3 ]; then rm -f zlib.3.pdf Makefile; fi
+	@if [ ! -f README.md ]; then rm -f Makefile; fi
 # Remove arch and test directory if building outside source tree
 	@if [ ! -f $(ARCHDIR)/Makefile.in ]; then rm -rf arch; fi
 	@if [ ! -f test/Makefile.in ]; then rm -rf test; fi

README.md

@@ -12,6 +12,7 @@ Maintained by Hans Kristian Rosbach
 |OSS-Fuzz|[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/zlib-ng.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:zlib-ng)
 |Codecov|[![codecov.io](https://codecov.io/github/zlib-ng/zlib-ng/coverage.svg?branch=develop)](https://codecov.io/github/zlib-ng/zlib-ng/)|
 
+
 Features
 --------
 
@@ -35,10 +36,11 @@ Features
 * GitHub Actions continuous integration on Windows, macOS, and Linux
   * Emulated CI for ARM, AARCH64, PPC, PPC64, SPARC64, S390x using qemu
 
-Fork Motivation
----------------------------
 
-The motivation for this fork was due to seeing several 3rd party
+History
+-------
+
+The motivation for this fork came after seeing several 3rd party
 contributions containing new optimizations not getting implemented
 into the official zlib repository.
 
@@ -74,6 +76,7 @@ improvements, or valuable testing.
 
 Please read LICENSE.md, it is very simple and very liberal.
 
+
 Build
 -----
 
@@ -107,6 +110,7 @@ make test
 
 Build Options
 -------------
+
 | CMake                    | configure                | Description                                                                           | Default |
 |:-------------------------|:-------------------------|:--------------------------------------------------------------------------------------|---------|
 | ZLIB_COMPAT              | --zlib-compat            | Compile with zlib compatible API                                                      | OFF     |
@@ -120,6 +124,7 @@ Build Options
 | WITH_MAINTAINER_WARNINGS |                          | Build with project maintainer warnings                                                | OFF     |
 | WITH_CODE_COVERAGE       |                          | Enable code coverage reporting                                                        | OFF     |
 
+
 Install
 -------
 
@@ -158,12 +163,10 @@ make install
 Contributing
 ------------
 
-Zlib-ng is a aiming to be open to contributions, and we would be
+Zlib-ng is a aiming to be open to contributions, and we would be delighted to
-delighted to receive pull requests on github.
+receive pull requests on github.
-Just remember that any code you submit must be your own and it must
+Just remember that any code you submit must be your own and it must be zlib licensed.
-be zlib licensed.
+Help with testing and reviewing of pull requests etc is also very much appreciated.
-Help with testing and reviewing of pull requests etc is also very
-much appreciated.
 
 If you are interested in contributing, please consider joining our
 IRC channel #zlib-ng on the Freenode IRC network.
@@ -174,9 +177,8 @@ Acknowledgments
 
 Thanks to Servebolt.com for sponsoring my maintainership of zlib-ng.
 
-Thanks go out to all the people and companies who have taken the time
+Thanks go out to all the people and companies who have taken the time to contribute
-to contribute code reviews, testing and/or patches. Zlib-ng would not
+code reviews, testing and/or patches. Zlib-ng would not have been nearly as good without you.
-have been nearly as good without you.
 
 The deflate format used by zlib was defined by Phil Katz.
 The deflate and zlib specifications were written by L. Peter Deutsch.
@@ -184,6 +186,7 @@ The deflate and zlib specifications were written by L. Peter Deutsch.
 zlib was originally created by Jean-loup Gailly (compression)
 and Mark Adler (decompression).
 
+
 Advanced Build Options
 ----------------------
 
@@ -205,3 +208,13 @@ Advanced Build Options
 | WITH_INFLATE_STRICT             |                       | Build with strict inflate distance checking                         | OFF                    |
 | WITH_INFLATE_ALLOW_INVALID_DIST |                       | Build with zero fill for inflate invalid distances                  | OFF                    |
 | INSTALL_UTILS                   |                       | Copy minigzip and minideflate during install                        | OFF                    |
+
+
+Related Projects
+----------------
+
+* Fork of the popular minigzip                  https://github.com/zlib-ng/minizip-ng
+* Python tool to benchmark minigzip/minideflate https://github.com/zlib-ng/deflatebench
+* Python tool to benchmark pigz                 https://github.com/zlib-ng/pigzbench
+* 3rd party patches for zlib-ng compatibility   https://github.com/zlib-ng/patches
+

zlib.3

@@ -1,149 +0,0 @@
-.TH ZLIB 3 "15 Jan 2017"
-.SH NAME
-zlib \- compression/decompression library
-.SH SYNOPSIS
-[see
-.I zlib.h
-for full description]
-.SH DESCRIPTION
-The
-.I zlib
-library is a general purpose data compression library.
-The code is thread safe, assuming that the standard library functions
-used are thread safe, such as memory allocation routines.
-It provides in-memory compression and decompression functions,
-including integrity checks of the uncompressed data.
-This version of the library supports only one compression method (deflation)
-but other algorithms may be added later
-with the same stream interface.
-.LP
-Compression can be done in a single step if the buffers are large enough
-or can be done by repeated calls of the compression function.
-In the latter case,
-the application must provide more input and/or consume the output
-(providing more output space) before each call.
-.LP
-The library also supports reading and writing files in
-.IR gzip (1)
-(.gz) format
-with an interface similar to that of stdio.
-.LP
-The library does not install any signal handler.
-The decoder checks the consistency of the compressed data,
-so the library should never crash even in the case of corrupted input.
-.LP
-All functions of the compression library are documented in the file
-.IR zlib.h .
-The distribution source includes examples of use of the library
-in the files
-.I test/example.c
-and
-.IR test/minigzip.c,
-as well as other examples in the
-.IR examples/
-directory.
-.LP
-Changes to this version are documented in the file
-.I ChangeLog
-that accompanies the source.
-.LP
-.I zlib
-is built in to many languages and operating systems, including but not limited to
-Java, Python, .NET, PHP, Perl, Ruby, Swift, and Go.
-.LP
-An experimental package to read and write files in the .zip format,
-written on top of
-.I zlib
-by Gilles Vollant (info@winimage.com),
-is available at:
-.IP
-http://www.winimage.com/zLibDll/minizip.html
-and also in the
-.I contrib/minizip
-directory of the main
-.I zlib
-source distribution.
-.SH "SEE ALSO"
-The
-.I zlib
-web site can be found at:
-.IP
-http://zlib.net/
-.LP
-The data format used by the
-.I zlib
-library is described by RFC
-(Request for Comments) 1950 to 1952 in the files:
-.IP
-http://tools.ietf.org/html/rfc1950 (for the zlib header and trailer format)
-.br
-http://tools.ietf.org/html/rfc1951 (for the deflate compressed data format)
-.br
-http://tools.ietf.org/html/rfc1952 (for the gzip header and trailer format)
-.LP
-Mark Nelson wrote an article about
-.I zlib
-for the Jan. 1997 issue of  Dr. Dobb's Journal;
-a copy of the article is available at:
-.IP
-http://marknelson.us/1997/01/01/zlib-engine/
-.SH "REPORTING PROBLEMS"
-Before reporting a problem,
-please check the
-.I zlib
-web site to verify that you have the latest version of
-.IR zlib ;
-otherwise,
-obtain the latest version and see if the problem still exists.
-Please read the
-.I zlib
-FAQ at:
-.IP
-http://zlib.net/zlib_faq.html
-.LP
-before asking for help.
-Send questions and/or comments to zlib@gzip.org,
-or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).
-.SH AUTHORS AND LICENSE
-Version 1.2.11
-.LP
-Copyright (C) 1995-2016 Jean-loup Gailly and Mark Adler
-.LP
-This software is provided 'as-is', without any express or implied
-warranty.  In no event will the authors be held liable for any damages
-arising from the use of this software.
-.LP
-Permission is granted to anyone to use this software for any purpose,
-including commercial applications, and to alter it and redistribute it
-freely, subject to the following restrictions:
-.LP
-.nr step 1 1
-.IP \n[step]. 3
-The origin of this software must not be misrepresented; you must not
-claim that you wrote the original software. If you use this software
-in a product, an acknowledgment in the product documentation would be
-appreciated but is not required.
-.IP \n+[step].
-Altered source versions must be plainly marked as such, and must not be
-misrepresented as being the original software.
-.IP \n+[step].
-This notice may not be removed or altered from any source distribution.
-.LP
-Jean-loup Gailly        Mark Adler
-.br
-jloup@gzip.org          madler@alumni.caltech.edu
-.LP
-The deflate format used by
-.I zlib
-was defined by Phil Katz.
-The deflate and
-.I zlib
-specifications were written by L. Peter Deutsch.
-Thanks to all the people who reported problems and suggested various
-improvements in
-.IR zlib ;
-who are too numerous to cite here.
-.LP
-UNIX manual page by R. P. C. Rodgers,
-U.S. National Library of Medicine (rodgers@nlm.nih.gov).
-.\" end of man page