From e106a158cb9fc990c4561f429117b38ad3d50d91 Mon Sep 17 00:00:00 2001 From: Braiden Vasco Date: Sun, 9 Jul 2017 16:59:16 +0000 Subject: [PATCH] Add build docs --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index df78b90..ee0b1f3 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Table of contents ----------------- * [Dependencies](#dependencies) +* [Build](#build) * [Network interfaces](#network-interfaces) * [eth0](#eth0) * [eth1](#eth1) @@ -34,6 +35,17 @@ file is `[:]`. +Build +----- + +Run `sudo ./build.sh` to build the image. The following files will be created: + +* `rootfs/` - the root file system (`/` and `/boot/` partitions) +* `deploy/YYYY-MM-DD-BarnacleOS.img` - the image to write to SD card +* `deploy/YYYY-MM-DD-BarnacleOS.zip` - ZIP archive with the image + + + Network interfaces ------------------