From 6773887596a2c34fe4719dde89b3006477d58e0a Mon Sep 17 00:00:00 2001 From: Mario1159 Date: Wed, 6 Sep 2023 03:55:42 -0300 Subject: [PATCH] Update README --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 31ed663..db50e65 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,12 @@ ## Usage -There are scripts provided for running the containers for each OS, this is because containers require binding the display enviroment variables to enable graphic output. +Follow these 3 steps to get your container ready. -### Starting a container with graphics output +### 1. Starting a container with graphics output + +Scripts are provided for creating the containers in both Windows and Linux. +These scripts automate the binding of graphics environment variables to the container in order to enable graphics inside the docker container. #### Windows @@ -29,11 +32,23 @@ Execute the next script in your terminal. Make sure you have `curl` already inst curl https://git.1159.cl/Mario1159/osic-stacks/raw/branch/main/scripts/linux_start.sh -o linux_start.sh ``` -### Connecting to the container -After starting the container enter to it executing a shell with docker. +### 2. Connecting to the container +After creating and starting the container, enter to it executing a shell with docker. ```sh docker exec -it bash ``` + +### 3. Configure Volare + +List the available PDKs and choose one to install. + +```sh +volare ls-remote --pdk +volare enable --pdk +``` + +After you have set up the PDK, you can finally start developing your own designs! + ## Build A singular stack image can be builded using docker in the following way.