Skip to content

Commit ef52f8c

Browse files
committed
Add basic documentation
1 parent abdc012 commit ef52f8c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# PyFPGA containers
22

3+
A collection of Docker containers featuring a curated selection of Free/Libre and Open-Source Software (FLOSS) tools for FPGA development.
4+
They streamline the setup process, ensuring consistency and easy access across diverse environments.
5+
Below is a list of the available containers and their included tools.
6+
37
* `langutils`: utilities for processing and analyzing HDL languages
48
* [vhd2vl](https://github.com/ldoolitt/vhd2vl)
59
* [Slang](https://github.com/MikePopoloski/slang)
@@ -17,3 +21,12 @@
1721
* [iVerilog](https://github.com/steveicarus/iverilog)
1822
* [Verilator](https://github.com/verilator/verilator)
1923
* [cocotb](https://github.com/cocotb/cocotb)
24+
25+
In the CI pipeline, the Dockerfile is used to build a Docker image, which is then pushed to the GitHub Container Registry.
26+
From there, it can be pulled and run as a container whenever needed.
27+
28+
```bash
29+
docker run --user $(id -u):$(id -g) --rm -v $PWD:$PWD -w $PWD ghcr.io/pyfpga/<image> <command>
30+
```
31+
32+
Replace `<image>` with the appropriate image name and `<command>` with the command you want to execute inside the container.

0 commit comments

Comments
 (0)