diff --git a/README.md b/README.md index 606a447..0e39daf 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,37 @@ # OSIC Stacks -## Open source Integrated Circuits Docker Stacks + Open source Integrated Circuits Docker Stacks -## Windows start container -```powershell -executionpolicy bypass -file .\wsl_start.ps1``` +## Stacks -## Build images -``` docker build -t -f .Dockerfile ``` \ No newline at end of file +- 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 + +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). + +```powershell -executionpolicy bypass -file .\scripts\wsl_start.ps1``` + +### Linux + +TODO: + +## 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``` + +## Custom Images \ No newline at end of file