From 6f91d4ea87ac0e724e78723b7680806eea838798 Mon Sep 17 00:00:00 2001 From: Mario1159 Date: Wed, 6 Sep 2023 01:02:53 -0300 Subject: [PATCH] Update README --- README.md | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 3873673..b54f087 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,46 @@ # OSIC Stacks - Open source Integrated Circuits Docker Stacks +*Open Source Integrated Circuits Docker Stacks* ## Stacks -- analog-xk: Analog workflow using XScheme & KLayout -- analog-xm: Analog workflow using XScheme & Magic -- digital-ator: Digital workflow using Verilator & Yosys -- digital-icarus: Digital workflow using Icarus & Yosys -- heavy: Workflow with all the previous tools +- **analog-xk**: Analog workflow using XScheme & KLayout +- **analog-xm**: Analog workflow using XScheme & Magic +- **digital-ator**: Digital workflow using Verilator & Yosys +- **digital-icarus**: Digital workflow using Icarus & Yosys +- **heavy**: Workflow with all the previous tools ## 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. -### Windows +### Starting a container with graphics output + +#### Windows Execute the next script in powershell. ```pwsh -iex "& { $(irm https://git.1159.cl/Mario1159/osic-stacks/raw/branch/main/scripts wsl_start.ps1) } Run Job" +iex "& { $(irm https://git.1159.cl/Mario1159/osic-stacks/raw/branch/main/scripts/wsl_start.ps1) } Run Job" ``` This script will run the container inside wsl and bind the enviroments variables for [wslg](https://github.com/microsoft/wslg/blob/main/samples/container/Containers.md). -### Linux - -TODO: +#### Linux +Execute the next script in your terminal. Make sure you have `curl` already installed. +```sh +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. +```sh +docker exec -it bash +``` ## Build A singular stack image can be builded using docker in the following way. > Note: Each stack image requires their correspondent base image installed. -```docker build -t -f .Dockerfile ``` - -For building all stacks, build the project with docker compose. - -```docker compose build``` +```sh +docker build -t -f .Dockerfile +``` ## Custom Images \ No newline at end of file