Port over code from kicad-pdf

.github/workflows/build.yml

@@ -97,10 +97,19 @@ jobs:
         id: render_template
         uses: chuhlomin/render-template@v1
         with:
-          template: action.template.yml
+          template: templates/action.template.yml
           result_path: action.yml
           vars: |
             image: docker://ghcr.io/${{ env.REPOSITORY_LC }}:${{ needs.version.outputs.version }}
+      - name: Update README.md
+        uses: recih/[email protected]
+        env:
+          ACTION_REPO: ${{ github.repository }}
+          ACTION_VERSION: ${{ needs.version.outputs.version }}
+        with:
+          template-file: templates/README.template.md
+          output-file: README.md
+          engine: mustache
       - uses: stefanzweifel/git-auto-commit-action@v5
         id: auto-commit
   release-main:

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
         id: render_template
         uses: chuhlomin/render-template@v1
         with:
-          template: action.template.yml
+          template: templates/action.template.yml
           result_path: action.yml
           vars: |
             image: Dockerfile
@@ -32,4 +32,20 @@ jobs:
       - uses: actions/upload-artifact@v4
         with:
           name: test-gerber
-          path: out/
+          path: out/
+  test-readme-generation:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Update README.md
+        uses: recih/[email protected]
+        env:
+          ACTION_REPO: ${{ github.repository }}
+          ACTION_VERSION: v1.0.0
+        with:
+          template-file: templates/README.template.md
+          output-file: README.md
+          engine: mustache
+      - name: Cat
+        run: cat README.md

templates/README.template.md

@@ -0,0 +1,24 @@
+# kicad-gerber Action
+
+Generates gerber & drill files for a specified PCB and places them in a specified directory
+
+## Inputs
+
+### `input-file`
+
+**Required** The PCB to process
+
+### `output-directory`
+
+The directory in which to place the gerber & drill files. Default "gerber".
+
+### `position-format`
+
+The position format to use. Options are gerber, csv, ascii, and none. Default "none".
+
+## Example usage
+```
+uses: {{{ ACTION_REPO }}}@{{{ ACTION_VERSION }}}
+with:
+  input-file: pcb.kicad_pcb
+```