zlib dependency not mentioned

[OlegBoulanov]

Describe the issue

sudo apt install zlib1g-dev

Links

README.md

[sbiscigl]

zlib dependency not mentioned

zlib is not a hard dependency of the SDK, its only required if you plan on using the request compression feature, which is currently only used in cloudwatch. Here is where we enable/disable request compressions based on if zlib is present. We do mention the optional-ness of this feature in our cmake docs

ENABLE_ZLIB_REQUEST_COMPRESSION
(Defaults to ON) For services that support it, request content will be compressed. On by default if dependency available

My question is then -- what sort of documentation would have been helpful for you to discover this information?/are you not seeing it as a optional dependency?

[OlegBoulanov]

Thank you for detailed explanation, @sbiscigl

I think listing it as an optional dependency in https://github.com/aws/aws-sdk-cpp#other-dependencies, along with installation command, would suffice.
I had to look up the information on zlib package name, so if providing it in README would be beneficial.

[kai-ion]

@OlegBoulanov Updated our readme under other-dependencies on zlib package and installation commands

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.