From e73261134e3c9b963f5e3758deff6f106fcc1755 Mon Sep 17 00:00:00 2001
From: Mike Key <mike@mk3y.com>
Date: Fri, 14 Jun 2024 21:50:20 -0600
Subject: [PATCH] documentation: Updated documentation to tackle TODO of
 explaining project

Signed-off-by: Mike Key <mike@mk3y.com>
---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 54 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7ac9011..bf238c2 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Asahi Linux installer
 
-TODO: document
+The Asahi Linux Installer is designed to facilitate the installation of Asahi Linux on compatible devices. This documentation provides instructions for building, configuring, and deploying the installer, along with licensing information.
 
 ## License
 
@@ -12,6 +12,57 @@ This installer vendors [python-asn1](https://github.com/andrivet/python-asn1), w
 
 ## Building
 
-`./build.sh`
+To build the Asahi Linux installer, run the following command:
+
+```sh
+./build.sh
+```
+
+By default this will build m1n1 with chainloading support. You can optionally set the following environment variables to customize the build:
+
+- `M1N1_STAGE1`: Path to a prebuilt m1n1 stage 1 binary.
+- `LOGO`: Path to a logo in ICNS format.
+
+These options are mainly useful for downstream distributions that want to customize or brand the installer.
+
+**Note*** *Before building the Asahi Linux installer, ensure that all submodules are initialized and updated. Run the following commands:*
+
+```sh
+git submodule update --init --recursive
+```
+
+### Build Script Overview
+
+The `build.sh` script performs several key steps to build the installer:
+
+- Set Environment Variables
+- Download Dependencies
+- Copies Files & Certificates
+- Build m1n1
+- Creates a targall of the package and saves it to the releases directory.
+
+## Deployment
+
+To deploy the built installer, use the upload.sh script:
+
+```sh
+./upload.sh [prod|dev]
+```
+
+prod: Deploys to the production directory.
+dev: Deploys to the development directory.
+
+
+## Testing the Installer
+
+To test the installer, use the following script:
+
+```sh
+test.sh
+```
+
+## Additional Information
+
+For more details and updates, visit the [Asahi Linux Installer repository](https://github.com/AsahiLinux/asahi-installer).
+
 
-By default this will build m1n1 with chainloading support. You can optionally set `M1N1_STAGE1` to a prebuilt m1n1 stage 1 binary, and `LOGO` to a logo in icns format. These are mostly useful for downstream distributions that would like to customize or brand the installer.