From 787993971bcdca8e63a0674fd8155a238b2084b4 Mon Sep 17 00:00:00 2001
From: kn0wmad <39687477+kn0wmad@users.noreply.github.com>
Date: Mon, 1 Nov 2021 17:25:56 -0600
Subject: [PATCH] Build README update (#738)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Build README update

* Formatting edit

* Formatting edit

* Formatting edit

* #️⃣ Make it simple (#743)

Co-authored-by: Mariusz Kogen <k0gen@pm.me>
---
 build/README.md | 46 ++++++++++++++++++++++++++--------------------
 1 file changed, 26 insertions(+), 20 deletions(-)

diff --git a/build/README.md b/build/README.md
index bb57fe114..0a9f55e4c 100644
--- a/build/README.md
+++ b/build/README.md
@@ -1,34 +1,40 @@
 # Building Embassy OS
 
+ The commands given assume a Debian or Ubuntu-based environment.
+
 ## Prerequisites
 
-1. Install dependences - The commands given assume a Debian or Ubuntu-based environment
+1. Install dependences
 
-- Rust
-	`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
-	https://rustup.rs
 - Avahi
-	`apt install avahi`
-	Installed by default on most Debian systems - https://avahi.org
+	- `sudo apt install -y avahi-daemon`
+	- Installed by default on most Debian systems - https://avahi.org
 - Docker
-	`apt install docker.io`
-	https://docs.docker.com/get-docker
+	- `sudo apt install -y docker.io`
+	- https://docs.docker.com/get-docker
+	- Add your user to the docker group: `sudo usermod -a -G docker $USER`
+	- If you have issues here, try to logout or reboot your system
+- Prepare Docker environment
+	- Setup buildx (https://docs.docker.com/buildx/working-with-buildx/)
+	- Create a builder: `docker buildx create --use`
+	- Add multi-arch build ability: `docker run --rm --privileged linuxkit/binfmt:v0.8`
 - Node
-	`apt install nodejs`
-	https://nodejs.org/en/docs
+	- `sudo apt install -y nodejs`
+	- https://nodejs.org/en/docs
 - NPM
-	`apt install npm`
-	https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
+	- `sudo apt install -y npm`
+	- https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
 - jq
-	`apt install jq`
-	https://stedolan.github.io/jq
+	- `sudo apt install -y jq`
+	- https://stedolan.github.io/jq
 
-2. Clone the repo and move into it
+2. Clone the repo, move into it, and bring in required submodules
 
-```
-git clone --recursive https://github.com/Start9Labs/embassy-os.git`
-cd embassy-os
-```
+	```
+	git clone --recursive https://github.com/Start9Labs/embassy-os.git
+	cd embassy-os
+	git submodule update --init --recursive
+	```
 
 ## Build
 
@@ -46,4 +52,4 @@ We recommend [Balena Etcher](https://www.balena.io/etcher/)
 
 Visit http://embassy.local from any web browser
 
-We recommend [Firefox](https://www.mozilla.org/en-US/firefox/browsers
+We recommend [Firefox](https://www.mozilla.org/firefox/browsers)