add ubuntu quickstart back to readme

goatgoose · Jul 31, 2023 · 12071b8 · 12071b8
1 parent 10bf557
commit 12071b8
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -13,9 +13,30 @@ s2n-tls is a C99 implementation of the TLS/SSL protocols that is designed to be
 [![Github stars](https://img.shields.io/github/stars/aws/s2n-tls.svg)](https://github.com/aws/s2n-tls/stargazers)
 [![Join the chat at https://gitter.im/awslabs/s2n](https://badges.gitter.im/awslabs/s2n.svg)](https://gitter.im/awslabs/s2n?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-## Building s2n-tls
+## Quickstart for Ubuntu
+
+```shell
+# clone s2n-tls
+git clone https://github.com/aws/s2n-tls.git
+cd s2n-tls
+
+# install build dependencies
+sudo apt update
+sudo apt install cmake ninja-build
+
+# install a libcrypto
+sudo apt install libssl-dev
+
+# build s2n-tls
+cmake . -Bbuild -GNinja \
+    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_INSTALL_PREFIX=./s2n-tls-install
+ninja -C build -j $(nproc)
+CTEST_PARALLEL_LEVEL=$(nproc) ninja -C build test
+ninja -C build install
+```
 
-See the [s2n-tls build documentation](docs/BUILD.md) for guidance on building s2n-tls for your platform.
+See the [s2n-tls build documentation](docs/BUILD.md) for further guidance on building s2n-tls for your platform.
 
 ## Have a Question?
 If you have any questions about Submitting PR's, Opening Issues, s2n-tls API usage, or something similar, we have a public chatroom available here to answer your questions: https://gitter.im/awslabs/s2n

diff --git a/docs/BUILD.md b/docs/BUILD.md
@@ -114,14 +114,14 @@ For help building a desired libcrypto on your platform, please consult the proje
 <summary>Ubuntu</summary>
 
 ```shell
-# install build dependencies
-sudo apt update
-sudo apt install cmake ninja-build golang
-
 # clone aws-lc locally
 git clone https://github.com/aws/aws-lc.git
 cd aws-lc
 
+# install build dependencies
+sudo apt update
+sudo apt install cmake ninja-build golang
+
 # build and install aws-lc
 cmake -GNinja -B build -DCMAKE_INSTALL_PREFIX=./aws-lc-install
 ninja -C build -j $(nproc)
@@ -134,13 +134,13 @@ ninja -C build install
 <summary>MacOS</summary>
 
 ```shell
-# install build dependencies
-brew install cmake ninja go
-
 # clone aws-lc locally
 git clone https://github.com/aws/aws-lc.git
 cd aws-lc
 
+# install build dependencies
+brew install cmake ninja go
+
 # build and install aws-lc
 cmake -GNinja -B build -DCMAKE_INSTALL_PREFIX=./aws-lc-install
 ninja -C build -j $(sysctl -n hw.ncpu)
@@ -153,14 +153,14 @@ ninja -C build install
 <summary>AL2</summary>
 
 ```shell
-# install build dependencies
-sudo yum groupinstall "Development Tools"
-sudo yum install cmake3 ninja-build perl golang
-
 # clone aws-lc locally
 git clone https://github.com/aws/aws-lc.git
 cd aws-lc
 
+# install build dependencies
+sudo yum groupinstall "Development Tools"
+sudo yum install cmake3 ninja-build perl golang
+
 # build and install aws-lc
 cmake -GNinja -B build -DCMAKE_INSTALL_PREFIX=./aws-lc-install
 ninja -C build -j $(nproc)
@@ -169,7 +169,7 @@ ninja -C build install
 ```
 </details>
 
-The aws-lc install location set by `CMAKE_INSTALL_PREFIX` should be specified when building s2n-tls with the `CMAKE_PREFIX_PATH` option. This will ensure that s2n-tls finds aws-lc when building.
+The AWS-LC install location set by `CMAKE_INSTALL_PREFIX` should be specified when building s2n-tls with the `CMAKE_PREFIX_PATH` option. This will ensure that s2n-tls finds aws-lc when building.
 
 For more information on building AWS-LC, see the [Building AWS-LC documentation](https://github.com/aws/aws-lc/blob/main/BUILDING.md)