Bump to 1.10.1

[platform/upstream/libzip.git] / INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
index 74e3e79..83f1d97 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,29 +1,34 @@
 libzip uses [cmake](https://cmake.org) to build.
 
-For running the tests, you need to have [perl](https://www.perl.org).
-
 You'll need [zlib](http://www.zlib.net/) (at least version 1.1.2). It
 comes with most operating systems.
 
 For supporting bzip2-compressed zip archives, you need
 [bzip2](http://bzip.org/).
 
-For supporting xz-compressed zip archives, you need
-[liblzma](https://tukaani.org/xz/) which is part of xz.
+For supporting lzma- and xz-compressed zip archives, you need
+[liblzma](https://tukaani.org/xz/) which is part of xz, at least version 5.2.
+
+For supporting zstd-compressed zip archives, you need
+[zstd](https://github.com/facebook/zstd/).
 
 For AES (encryption) support, you need one of these cryptographic libraries,
 listed in order of preference:
 
 - Apple's CommonCrypto (available on macOS and iOS)
-- [GnuTLS](https://www.gnutls.org/)
-- [mbed TLS](https://tls.mbed.org/)
-- [OpenSSL](https://www.openssl.org/) >= 1.0.
 - Microsoft Windows Cryptography Framework
+- [OpenSSL](https://www.openssl.org/) >= 1.0.
+- [GnuTLS](https://www.gnutls.org/) and [Nettle](https://www.lysator.liu.se/~nisse/nettle/) (at least nettle 3.0)
+- [mbed TLS](https://tls.mbed.org/)
 
 If you don't want a library even if it is installed, you can
 pass `-DENABLE_<LIBRARY>=OFF` to cmake, where `<LIBRARY>` is one of
 `COMMONCRYPTO`, `GNUTLS`, `MBEDTLS`, or `OPENSSL`.
 
+For running the tests, you need to have
+[Python](https://www.python.org/) and
+[nihtest](https://pypi.org/project/nihtest/) installed.
+
 The basic usage is
 ```sh
 mkdir build
@@ -39,13 +44,13 @@ Some useful parameters you can pass to `cmake` with `-Dparameter=value`:
 - `BUILD_SHARED_LIBS`: set to `ON` or `OFF` to enable/disable building
   of shared libraries, defaults to `ON`
 - `CMAKE_INSTALL_PREFIX`: for setting the installation path
-- `DOCUMENTATION_FORMAT`: choose one of 'man', 'mdoc', and 'html' for
+- `DOCUMENTATION_FORMAT`: choose one of `man`, `mdoc`, and `html` for
   the installed documentation (default: decided by cmake depending on
   available tools)
 - `LIBZIP_DO_INSTALL`: If you include libzip as a subproject, link it
   statically and do not want to let it install its files, set this
   variable to `OFF`. Defaults to `ON`.
-  
+
 If you want to compile with custom `CFLAGS`, set them in the environment
 before running `cmake`:
 ```sh
@@ -63,4 +68,4 @@ will break in `zipcmp`.
 You can get verbose build output with by passing `VERBOSE=1` to
 `make`.
 
-You can also check the [cmake FAQ](https://cmake.org/Wiki/CMake_FAQ).
+You can also check the [cmake FAQ](https://gitlab.kitware.com/cmake/community/-/wikis/FAQ).