From b2fe0a389aa0eb51238fde6c540d2366d6bc55c9 Mon Sep 17 00:00:00 2001
From: Valentin Raevsky <valentin@compulab.co.il>
Date: Tue, 28 May 2024 11:49:13 +0300
Subject: [PATCH] Add README.md

Signed-off-by: Valentin Raevsky <valentin@compulab.co.il>
---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..79911eae61a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Disclaimer
+
+| !IMPORTANT! | This is a development branch, that is not relelased by CompuLab yet|
+|---|---|
+
+# Configuring the build
+
+## Prerequisites
+It is up to developers to prepare the host machine; it requires:
+
+* [Setup Cross Compiler](https://github.com/compulab-yokneam/meta-bsp-imx8mp/blob/kirkstone/Documentation/toolchain.md#linaro-toolchain-how-to)
+* Install these packages: ``shareutils, swing``
+
+
+## Setup U-Boot environment
+
+* WorkDir:
+```
+mkdir -p compulab-bootloader/build && cd compulab-bootloader
+export BUILD=$(pwd)/build
+```
+
+* Set a CompuLab machine:
+
+| Machine | Command Line |
+|---|---|
+|ucm-imx8m-plus|```export MACHINE=ucm-imx8m-plus```|
+|som-imx8m-plus|```export MACHINE=som-imx8m-plus```|
+|iot-gate-imx8plus|```export MACHINE=iot-gate-imx8plus```|
+
+* Clone the source code:
+```
+git clone --branch u-boot-compulab_v2021.04 https://github.com/compulab-yokneam/u-boot-compulab.git
+cd u-boot-compulab
+```
+
+## Create U-boot binary
+
+* Apply the machine Config
+```
+make O=${BUILD} ${MACHINE}_defconfig
+```
+
+* Build
+```
+nice make -j`nproc` O=${BUILD} flash.bin
+```
+
+* Result
+```
+ls -al ${BUILD}/flash.bin
+```