Skip to content

Commit

Permalink
README.md: document the supported compilers
Browse files Browse the repository at this point in the history
  • Loading branch information
ebiggers committed Mar 1, 2024
1 parent 9e435af commit 5e93d97
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5e93d97

Please sign in to comment.