Skip to content

Commit 9951242

Browse files
committed
add readme, clean up workflow names
1 parent 1570ba4 commit 9951242

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

.github/workflows/docker-publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151

5252
# Build just the amd64 container to validate the build
5353
# https://github.com/docker/build-push-action
54-
- name: Build and push Docker image
54+
- name: Validate Docker image build
5555
if: github.event_name != 'release'
5656
id: build-only
5757
uses: docker/build-push-action@v3
@@ -65,7 +65,7 @@ jobs:
6565

6666
# Build and push Docker image with Buildx
6767
# https://github.com/docker/build-push-action
68-
- name: Build and push Docker image
68+
- name: Build and publish Docker image
6969
if: github.event_name == 'release'
7070
id: build-and-push
7171
uses: docker/build-push-action@v3

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# TCG Pandoc Containers
2+
3+
These Docker containers contain the dependencies needed to build TCG
4+
Markdown-based documents. The main anticipated consumer of these
5+
containers is
6+
[the Markdown action](https://github.com/trustedcomputinggroup/markdown),
7+
but anyone can download and use the containers with Docker.
8+
9+
The interesting dependencies are:
10+
11+
* [Pandoc](https://pandoc.org)
12+
* [LaTeX](https://www.latex-project.org) /
13+
[TexLive](https://www.tug.org/texlive/))
14+
(a dependency of Pandoc for PDF generation)
15+
* [Eisvogel](https://github.com/Wandmalfarbe/pandoc-latex-template)
16+
(Pandoc/LaTeX template, with some TCG-specific modifications)
17+
* [Mermaid](https://mermaid-js.github.io/mermaid/#/) /
18+
[mermaid-filter](https://github.com/raghur/mermaid-filter) (for rendering diagrams)

0 commit comments

Comments
 (0)