Skip to content

Commit

Permalink
support tables
Browse files Browse the repository at this point in the history
  • Loading branch information
kagarmoe committed Aug 18, 2023
1 parent 3ae689f commit 1e0c777
Showing 1 changed file with 35 additions and 3 deletions.
38 changes: 35 additions & 3 deletions docs/BUILD.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,45 @@
# Building s2n-tls

To use s2n-tls, you must build the library from the source and then include it in your program.
## Requirements

s2n-tls builds on modern Linux and linux-based systems.ns2n-tls does not support [Windows](https://github.com/aws/s2n-tls/issues/497).
s2n-tls supports and tests on **x86** and **arm** architectures.

### System requirements

* 20GB RAM availible

### Supported OS and Distributions:

| OS | Distros | | |
|--------|---------|------|--------|
| Redhat | Fedora | AL |
| debian | ubuntu |
| *BSD | free | open | darwin |

s2n-tls does not support [Windows](https://github.com/aws/s2n-tls/issues/497).

<!-- We may want to move in this direction:
### Redhat
#### Fedora
| Version | Kernel |
|---------|--------|
| 37 | 6.0 |
| 38 | 6.2 | -->


### Software requirements

Building s2n-tls requires:

1. Git
1. GCC or Clang
1. CMake
1. OpenSSL
1. Build tools for your platform
1. Platform-specific build tools

## Building s2n-tls from the source

Expand Down Expand Up @@ -212,7 +242,9 @@ CTEST_PARALLEL_LEVEL=$(nproc) ctest --test-dir build
```
</details>

## Memory managment and system limits
## Troubleshooting

### Memory managment and system limits (mlock failures)

s2n-tls uses `mlock()` to prevent memory from being swapped to disk. The
s2n-tls build tests may fail in some environments if the default limit on locked
Expand Down

0 comments on commit 1e0c777

Please sign in to comment.