From b76678c67bc1994f05607ee12825b1ad79f32bfb Mon Sep 17 00:00:00 2001
From: Pete Fotheringham <petefoth@e.email>
Date: Mon, 2 Sep 2024 11:36:26 +0100
Subject: [PATCH] Add outline documentation

---
 src/new_build.sh | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/src/new_build.sh b/src/new_build.sh
index 86e393e..66dbdfc 100644
--- a/src/new_build.sh
+++ b/src/new_build.sh
@@ -17,3 +17,31 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>
+
+
+# Outline
+# - Call `begin.sh`
+# - Handle parameters and environment variables
+#      -  CLEAN_OUTDIR
+#      -  PARALLEL_JOBS
+#      -  RETRY_FETCHES
+# - handle manifests
+# - Sync mirror
+# - Branch-specific stuff
+# -  main sync and build loop For each device in `$DEVICE_LIST`
+#     - setup build overlay
+#     - `repo init`
+#     - `repo sync`
+#     - Call `before.sh`
+#     - `breakfast` - in case of failure, call
+#         - `post-build.sh`
+#         - `do_cleanup`
+#     - `mka`
+#     - move artefacts to `ZIPDIR`
+#         - ROM zip file
+#         - `.img` files
+#         - create the checksum files
+#         - Remove old zips and logs
+#     - call `post-build.sh`
+#     - call `do_cleanup`
+# - call `end.sh`