add README.md

.github/workflows/build.yml

@@ -2,26 +2,26 @@ name: ci
 
 on:
   push:
+    branches:
+      main
 
 jobs:
   docker:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Login to Docker Hub
+      - name: Login to Docker Hub
         uses: docker/login-action@v3
         with:
           username: ${{ vars.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
-        name: Set up QEMU
+      - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
-      -
-        name: Set up Docker Buildx
+      - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
-      -
-        name: Build and push
+      - name: Build and push
         uses: docker/build-push-action@v6
         with:
           push: true
-          tags: brendanhaines/iverilog:latest
+          tags: brendanhaines/iverilog:latest
+          build-args:
+            ANNOTATION_DESCRIPTION="${{ github.server_url }}/${{ github.repository }}"

Dockerfile

@@ -1,6 +1,5 @@
 FROM ubuntu:22.04
-RUN \
-    apt update && \
+RUN apt update && \
     apt install -y autoconf gperf make gcc g++ bison flex && \
     apt clean
 
@@ -10,8 +9,7 @@ WORKDIR /iverilog
 # RUN git clone --recursive https://github.com/steveicarus/iverilog.git
 
 # BUILD RELEASED CODE
-RUN \
-    apt update && \
+RUN apt update && \
     apt install -y wget && \
     apt clean
 RUN wget https://github.com/steveicarus/iverilog/archive/refs/tags/v12_0.tar.gz && \

README.md

@@ -0,0 +1,8 @@
+# Icarus Verilog Docker Container
+
+## Usage
+`docker pull brendanhaines/iverilog:latest`
+
+`iverilog` is on `PATH`
+
+This image is based on `ubuntu` and therefore is huge.