From ef52f8c7b2ba6e9e1e1ca9ccecc0654b72decec6 Mon Sep 17 00:00:00 2001
From: "Rodrigo A. Melo" <rodrigomelo9@gmail.com>
Date: Wed, 8 Jan 2025 21:31:28 -0300
Subject: [PATCH] Add basic documentation

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 501acaf..67ae49e 100644
--- a/README.md
+++ b/README.md
@@ -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)
@@ -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.