fixes

goatgoose · Jul 30, 2023 · 7feadc1 · 7feadc1
1 parent 2914950
commit 7feadc1
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/docs/BUILD.md b/docs/BUILD.md
@@ -49,6 +49,7 @@ s2n-tls can be configured with the following CMake options. Each option can be c
 - [**`CMAKE_BUILD_TYPE`**](https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html): Sets the build type. Some of the possible build types are as follows:
   - `Release`: Produce an optimized s2n-tls library artifact with no debug info. This option should be used when building s2n-tls for use in production.
   - `Debug`: Produce an unoptimized library artifact with debug info. This option can be used when developing for or with s2n-tls. The debug symbols produced with this build can be used with GDB or to generate more informative stack traces.
+- [**`BUILD_SHARED_LIBS`**](https://cmake.org/cmake/help/latest/variable/BUILD_SHARED_LIBS.html): Specifies whether a static or shared s2n-tls library artifact will be produced during the build. Defaults to `OFF`, building a static library. If set to `ON`, a shared library will be produced instead.
 
 The entire list of s2n-tls CMake options can be viewed with `cmake . -LH`. 
 
@@ -60,11 +61,11 @@ s2n-tls has a single library dependency: the libcrypto. The libcrypto contains c
 - [BoringSSL](https://boringssl.googlesource.com/boringssl)
 - [LibreSSL](https://www.libressl.org/)
 
-Any of the above libcryptos can be built and linked to s2n-tls by specifying the libcryot's install path with the `CMAKE_PREFIX_PATH` option. Please refer to the desired project's build instructions for help building the libcrypto on your operating system.
+By default, s2n-tls will attempt to find a libcrypto on the system to link with when building. However, this search can be overridden with any of the above libcryptos by specifying the install directory with the `CMAKE_PREFIX_PATH` flag. For help building a desired libcrypto on your platform, please consult the project's build documentation.
 
 ### AWS-LC
 
-[AWS-LC](https://github.com/aws/aws-lc) is the recommended libcrypto to use with s2n-tls due to increased performance and security. AWS-LC can be built via the following:
+[AWS-LC](https://github.com/aws/aws-lc) is the recommended libcrypto to use with s2n-tls due to increased performance and security. AWS-LC can be built with the following:
 
 <details open>
 <summary>Ubuntu</summary>
@@ -111,10 +112,9 @@ s2n-tls can be built via CMake without a dependency on Ninja:
 <summary>Ubuntu</summary>
 
 ```
-cmake . -Bbuild \
-    -DCMAKE_PREFIX_PATH=$(dirname $(dirname $(brew list openssl@3|grep libcrypto.dylib)))
-cmake --build build -j $(sysctl -n hw.ncpu)
-CTEST_PARALLEL_LEVEL=$(sysctl -n hw.ncpu) ctest --test-dir build
+cmake . -Bbuild
+cmake --build build -j $(nproc)
+CTEST_PARALLEL_LEVEL=$(nproc) ctest --test-dir build
 ```
 </details>