Skip to content

Commit

Permalink
docs: Add a supported platforms section (#4695)
Browse files Browse the repository at this point in the history
  • Loading branch information
dougch committed Aug 20, 2024
1 parent 057e2ca commit 98bfc2c
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,35 @@ Documentation for older versions or branches of s2n-tls can be generated locally

Doxygen installation instructions are available at the [Doxygen](https://doxygen.nl/download.html) webpage.

## Platform Support

We’ve listed the distributions and platforms under two tiers: Tier 1 platforms are guaranteed to build, run, and pass tests in CI. Tier 2 platforms are guaranteed to build and we'll address issues opened against them, but they aren't currently running in our CI and are not actively reviewed with every commit. If you use a platform not listed below and would like to request (or help!) add it to our CI, please open an issue for discussion.

### Tier 1

|Distribution in CI |Platforms |
|-------------------------------------------------------|-----------------|
|Ubuntu18, Ubuntu24** | x86_64 |
|Ubuntu22 | x86_64, i686 |
|AL2, AL2023** | x86_64, aarch64 |
|NixOS | x86_64, aarch64 |
|OpenBSD [7.4](https://github.com/cross-platform-actions/action/blob/master/readme.md#supported-platforms)| x86_64 |
|FreeBSD [latest](https://github.com/vmactions/freebsd-vm/blob/v1/conf/default.release.conf)| x86_64 |
|OSX [latest](https://github.com/actions/runner-images?tab=readme-ov-file#available-images) | aarch64 |

**Work in Progress

### Tier 2

|Distribution not in CI |Platforms|
|-----------------------|---------|
| Fedora Core 34-36 | x86_64, aarch64 |
| Ubuntu14/16/20 | x86_64, aarch64 |
| Ubuntu18/22/24 | aarch64 |
| [OSX](https://github.com/actions/runner-images/tree/main/images/macos) 12-14 |x86_64|

These distribution lists are not exhaustive and missing tooling or a missing supported libcrypto library could prevent a successful build.

## Using s2n-tls

The s2n-tls I/O APIs are designed to be intuitive to developers familiar with the widely-used POSIX I/O APIs, and s2n-tls supports blocking, non-blocking, and full-duplex I/O. Additionally there are no locks or mutexes within s2n-tls.
Expand Down

0 comments on commit 98bfc2c

Please sign in to comment.