Skip to content

Add basic documentation #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rodrigomelo9 merged 1 commit into from
Jan 9, 2025
Merged

Add basic documentation #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# PyFPGA containers

A collection of Docker containers featuring a curated selection of Free/Libre and Open-Source Software (FLOSS) tools for FPGA development.
They streamline the setup process, ensuring consistency and easy access across diverse environments.
Below is a list of the available containers and their included tools.

* `langutils`: utilities for processing and analyzing HDL languages
* [vhd2vl](https://github.com/ldoolitt/vhd2vl)
* [Slang](https://github.com/MikePopoloski/slang)
Expand All @@ -17,3 +21,12 @@
* [iVerilog](https://github.com/steveicarus/iverilog)
* [Verilator](https://github.com/verilator/verilator)
* [cocotb](https://github.com/cocotb/cocotb)

In the CI pipeline, the Dockerfile is used to build a Docker image, which is then pushed to the GitHub Container Registry.
From there, it can be pulled and run as a container whenever needed.

```bash
docker run --user $(id -u):$(id -g) --rm -v $PWD:$PWD -w $PWD ghcr.io/pyfpga/<image> <command>
```

Replace `<image>` with the appropriate image name and `<command>` with the command you want to execute inside the container.
Loading