Mario1159/osic-stacks
1
1
Fork 1
Code Issues 11 Pull Requests Actions Packages Projects 2 Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Mario Romero 2023-09-06 01:02:53 -03:00
parent a17e1f9078
commit 6f91d4ea87
1 changed files with 23 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,39 +1,46 @@
# OSIC Stacks # OSIC Stacks
Open source Integrated Circuits Docker Stacks *Open Source Integrated Circuits Docker Stacks*
## Stacks ## Stacks
- analog-xk: Analog workflow using XScheme & KLayout - **analog-xk**: Analog workflow using XScheme & KLayout
- analog-xm: Analog workflow using XScheme & Magic - **analog-xm**: Analog workflow using XScheme & Magic
- digital-ator: Digital workflow using Verilator & Yosys - **digital-ator**: Digital workflow using Verilator & Yosys
- digital-icarus: Digital workflow using Icarus & Yosys - **digital-icarus**: Digital workflow using Icarus & Yosys
- heavy: Workflow with all the previous tools - **heavy**: Workflow with all the previous tools
## Usage ## 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. 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. Execute the next script in powershell.
```pwsh ```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). 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 #### Linux
Execute the next script in your terminal. Make sure you have `curl` already installed.
TODO: ```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 ## Build
A singular stack image can be builded using docker in the following way. A singular stack image can be builded using docker in the following way.
> Note: Each stack image requires their correspondent base image installed. > Note: Each stack image requires their correspondent base image installed.
```docker build -t <tag> -f <arch/jammy>.Dockerfile <path>``` ```sh
docker build -t <tag> -f <arch/jammy>.Dockerfile <path>
For building all stacks, build the project with docker compose. ```
```docker compose build```
## Custom Images ## Custom Images