Skip to content

Commit 6c224f1

Browse files
Vollstreckermadler
authored andcommitted
CMake: Change README-cmake to README-cmake.md with formatting.
Per @ClausKlein suggestion.
1 parent 213998f commit 6c224f1

File tree

2 files changed

+83
-76
lines changed

2 files changed

+83
-76
lines changed

README-cmake.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# For building with cmake at least version 3.12 (minizip 3.12) is needed
2+
3+
In most cases the usual
4+
5+
cmake -S . -B build -D CMAKE_BUILD_TYPE=Release
6+
7+
will create everything you need, however if you want something off default you can adjust several options fit your needs.
8+
Every option is list below (excluding the cmake-standard options), they can be set via cmake-gui or on cmdline with
9+
10+
-D<option>=ON/OFF
11+
12+
## ZLIB-options with defaults ##
13+
14+
ZLIB_BUILD_TESTING=ON -- Enable Zlib Examples as tests
15+
16+
ZLIB_BUILD_SHARED=ON -- Enable building zlib shared library
17+
18+
ZLIB_BUILD_STATIC=ON -- Enable building zlib static library
19+
20+
ZLIB_BUILD_MINIZIP=ON -- Enable building libminizip contrib library
21+
22+
If this option is turned on, additional options are available from minizip (see below)
23+
24+
ZLIB_INSTALL=ON -- Enable installation of zlib
25+
26+
ZLIB_PREFIX=OFF -- prefix for all types and library functions, see zconf.h.in
27+
28+
ZLIB_INSTALL_COMPAT_DLL=ON -- Install a copy as zlib1.dll
29+
30+
This option is only on windows available and may/will be turned off and removed somewhen in the future.
31+
If you rely cmake for finding and using zlib, this can be turned off, as `zlib1.dll` will never be used.
32+
33+
## minizip-options with defaults ##
34+
35+
MINIZIP_BUILD_SHARED=ON -- Enable building minizip shared library
36+
37+
MINIZIP_BUILD_STATIC=ON -- Enable building minizip static library
38+
39+
MINIZIP_BUILD_TESTING=ON -- Enable testing of minizip
40+
41+
MINIZIP_ENABLE_BZIP2=ON -- Build minizip withj bzip2 support
42+
43+
A usable installation of bzip2 is needed or config will fail. Turn this option of in this case.
44+
45+
MINIZIP_INSTALL=ON -- Enable installation of minizip
46+
47+
MINIZIP_INSTALL_COMPAT_DLL=ON -- Install a copy as libminizip-1.dll
48+
49+
This option is only available on mingw as they tend to name this lib different. Maybe this will also be
50+
removed in the future as. If you rely cmake for finding and using zlib, this can be turned off, as
51+
the other file will never be used.
52+
53+
## Using the libs ##
54+
55+
To pull in what you need it's enough to just write
56+
57+
find_package(ZLIB CONFIG)
58+
59+
or
60+
61+
find_package(minizip CONFIG)
62+
63+
in your CMakeLists.txt, however it is advised to specify what you really want via:
64+
65+
find_package(ZLIB CONFIG COMPONENTS shared static REQUIRED)
66+
67+
or
68+
69+
find_package(minizip CONFIG COMPONENTS shared static REQUIRED)
70+
71+
As it's possible to only build the shared or the static lib, you can make sure that everything you need
72+
is found. If no COMPONENTS are requested, everything that is found will satisfy your request. If the
73+
libraries are optional in you project, you can omit the REQUIRED and check yourself if the targets you
74+
want to link against are created.
75+
76+
When you search for minizip, it will search zlib for you, so only one of both is needed.
77+
78+
## Imported targets ##
79+
80+
When found the following targets are created for you:
81+
82+
ZLIB::ZLIB and ZLIB::ZLIBSTATIC -- for zlib
83+
MINIZIP::minizip and MINIZIP::minizipstatic -- for minizip

README.cmake

Lines changed: 0 additions & 76 deletions
This file was deleted.

0 commit comments

Comments
 (0)