Skip to content

Commit 1728889

Browse files
committed
update readme to include zlib dependencies
1 parent a4f1eb6 commit 1728889

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

README.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,23 @@ AWS SDK for C++ is now in General Availability and recommended for production us
5050
**_NOTE:_** BUILD_ONLY is an optional flag used to list only the services you are using. Building the whole SDK can take a long time. Also, check out the list of [CMake parameters](./docs/CMake_Parameters.md)
5151

5252
#### Other Dependencies:
53-
To compile on Linux, you must have the header files for libcurl, libopenssl, and zlib. The packages are typically available in your package manager.
53+
To compile on Linux, you must have the header files for libcurl, libopenssl. The packages are typically available in your package manager.
5454

5555
Debian based Linux distributions example:
56-
`sudo apt-get install libcurl4-openssl-dev libssl-dev zlib1g-dev`
56+
`sudo apt-get install libcurl4-openssl-dev libssl-dev`
5757

5858
RPM based Linux distributions example:
59-
`sudo [yum|dnf|zypper] install libcurl-devel openssl-devel zlib-devel`
59+
`sudo [yum|dnf|zypper] install libcurl-devel openssl-devel`
6060

61-
SUSE example:
62-
`sudo zypper install libcurl-devel libopenssl-devel zlib-devel`
61+
Optional: zlib (for compression)
62+
zlib is **optional** and only required if you need gzip/deflate compression
63+
support (for example, when your libcurl and workloads use HTTP content-encoding).
64+
If your libcurl is already built with zlib, you typically don't need to install
65+
zlib headers separately unless your build complains about missing zlib.
6366
64-
Arch example:
65-
`sudo pacman -S curl openssl zlib`
66-
67-
Why zlib? It's required for HTTP compression/decompression support used by the SDK and its HTTP stack.
67+
Install if needed:
68+
- Debian/Ubuntu: `sudo apt-get install zlib1g-dev`
69+
- RPM-based: `sudo [yum|dnf|zypper] install zlib-devel`
6870
6971
### Building for MacOS
7072
@@ -82,15 +84,6 @@ You must install the [xcode command line tools](https://mac.install.guide/comman
8284
> ..
8385
> ```
8486
85-
zlib on macOS:
86-
If CMake cannot find zlib, install it with Homebrew and add it to your CMake prefix path:
87-
```
88-
brew install zlib
89-
cmake -DCMAKE_PREFIX_PATH="/opt/homebrew/opt/curl;/opt/homebrew/opt/zlib" \
90-
-DZLIB_ROOT=/opt/homebrew/opt/zlib \
91-
<other options> ..
92-
```
93-
9487
### Building for Android
9588
To build for Android, add `-DTARGET_ARCH=ANDROID` to your CMake command line. Currently, we support Android APIs from 19 to 28 with Android NDK 19c, and we are using the built-in CMake toolchain file supplied by Android NDK, assuming you have the appropriate environment variables (ANDROID_NDK) set.
9689

0 commit comments

Comments
 (0)