From 5e93d97acfd2e6a336151b77bceb26857058309e Mon Sep 17 00:00:00 2001 From: Eric Biggers Date: Fri, 1 Mar 2024 00:36:43 -0800 Subject: [PATCH] README.md: document the supported compilers --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 81cfc867..7e183186 100644 --- a/README.md +++ b/README.md @@ -77,11 +77,21 @@ You should compile both `lib/*.c` and `lib/*/*.c`. You don't need to worry about excluding irrelevant architecture-specific code, as this is already handled in the source files themselves using `#ifdef`s. -It is strongly recommended to use either gcc or clang, and to use `-O2`. - If you are doing a freestanding build with `-ffreestanding`, you must add `-DFREESTANDING` as well (matching what the `CMakeLists.txt` does). +## Supported compilers + +Currently the following compilers are supported for building libdeflate: + +- gcc: v5.1 or later +- clang: v3.9 or later +- MSVC: Visual Studio 2019 or later +- Other compilers: any version should work + +gcc or clang is recommended. The recommended optimization level is `-O2`. In +some cases compilers older than those listed above may work, but are untested. + # API libdeflate has a simple API that is not zlib-compatible. You can create