forked from Mario1159/osic-stacks
46 lines
1.5 KiB
Markdown
46 lines
1.5 KiB
Markdown
# OSIC 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
|
|
|
|
## 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.
|
|
|
|
### Starting a container with graphics output
|
|
|
|
#### Windows
|
|
|
|
Execute the next script in powershell.
|
|
```pwsh
|
|
& ([scriptblock]::Create((irm https://git.1159.cl/Mario1159/osic-stacks/raw/branch/main/scripts/wsl_start.ps1))) -remote
|
|
```
|
|
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
|
|
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 <container_name> 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.
|
|
|
|
```sh
|
|
docker build -t <tag> -f <arch/jammy>.Dockerfile <path>
|
|
```
|
|
|
|
## Custom Images |