From 6988465183ab3489b9ce10e6617e3fcda7a224e0 Mon Sep 17 00:00:00 2001 From: Peter McGoron Date: Fri, 2 Jun 2023 16:25:01 -0400 Subject: [PATCH] README --- Makefile | 5 ----- environment_setup.md => README.md | 25 +++++++++++++++++++++---- 2 files changed, 21 insertions(+), 9 deletions(-) rename environment_setup.md => README.md (56%) diff --git a/Makefile b/Makefile index b09c7a6..4d62846 100644 --- a/Makefile +++ b/Makefile @@ -2,11 +2,6 @@ buildroot-image litex-f4pga-image hardware-container \ upsilon.tar.gz upsilon-opensbi.tar.gz -help: - @echo 'compile commands (run in order)' - @echo 'make clone: clone repositories' - @echo 'make images: build docker images' - ###### Images images: hardware-image buildroot-image opensbi-image diff --git a/environment_setup.md b/README.md similarity index 56% rename from environment_setup.md rename to README.md index 0b8eb2f..8d7f90b 100644 --- a/environment_setup.md +++ b/README.md @@ -1,7 +1,7 @@ -Upsilon development environment setup. +Upsilon docker development environment setup. Written by Peter McGoron. -# Preqreuisites +# Setup steps ## Rebinding Caps Lock to Escape @@ -33,6 +33,23 @@ If you have issues with docker, try adding to `~/.config/docker/daemon.json` Install `python3-venv` (or `python3-virtualenv`) and `python3-pip`. -# Setup Build Environment +## Clone External Repositories + +Run `make clone`. You may need to download the upsilon repositories +and put them in the same folder as the Makefile. + +## Setup Images + +Run `make images` to create all docker images. + +## Setup and Run Containers + +There are three containers: `hardware`, `buildroot`, and `opensbi`. For +each of these: + +1. Run `make $NAME-container` to build the container. +2. Run `make $NAME-container-copy` to copy Upsilon's code into the container. +3. Run `make $NAME-container-execute` to build the data. +4. Run `make $NAME-container-get` to retrieve the build artefacts. +5. (Optionally) run `make $NAME-container-clean` to delete the container. -Run `make image container attach`.