From 66fc9f311dafaa51764d330f54e63df02319f5ac Mon Sep 17 00:00:00 2001
From: Matthew James Briggs <matthew.james.briggs@gmail.com>
Date: Thu, 30 Nov 2023 14:32:57 -0800
Subject: [PATCH] readme: describe alpha sdk build process

Co-authored-by: Ethan Pullen <pullenep@amazon.com>
Co-authored-by: Matthew James Briggs <matthew.james.briggs@gmail.com>
---
 local/README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/local/README.md b/local/README.md
index 09ee0ae23..eb4041b6b 100644
--- a/local/README.md
+++ b/local/README.md
@@ -1,3 +1,55 @@
+# Building The Alpha SDK
+
+## Required tools
+* git
+* cargo
+* docker
+
+## Clone Bottlerocket
+
+We will start by cloning Bottlerocket so it can be used to create the alpha variant.
+
+```bash
+git clone https://github.com/bottlerocket-os/bottlerocket.git
+```
+
+## Clone Twoliter
+
+Next we will clone the twoliter project.
+
+```bash
+git clone https://github.com/bottlerocket-os/twoliter.git
+```
+
+## Build the alpha sdk
+
+The alpha sdk script will build bottlerocket from the main repo, so we need to provide it's path.
+Add the path to the command below.
+
+```bash
+BOTTLEROCKET_PROJECT_DIR=
+```
+
+Next we need to configure the image that is created by twoliter.
+```bash
+# The ecr registry the alpha sdk should be pushed to
+ALPHA_SDK_REGISTRY=
+# The version for this alpha sdk
+ALPHA_SDK_VERSION=
+```
+
+To build the sdk we need to call the `alpha-sdk.sh` script.
+
+```bash
+# From within the twoliter project
+cd local
+./alpha-sdk.sh \
+    --bottlerocket-dir ${BOTTLEROCKET_PROJECT_DIR} \
+    --alpha-registry ${ALPHA_SDK_REGISTRY} \
+    --alpha-version ${ALPHA_SDK_VERSION}
+cd ..
+```
+
 # The Local Directory
 
 This directory is for scripts involved with building and testing Twoliter.