Skip to content

Commit f2afb7b

Browse files
committed
docs: Add a remark on the markdown badge
1 parent 38cd02c commit f2afb7b

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

.github/workflows/build-coq-demo.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,9 @@ jobs:
5656
with:
5757
opam_file: './coq-demo.opam'
5858
custom_image: ${{ matrix.image }}
59+
60+
# Remark:
61+
# you may want to add the following badge to your README.md:
62+
# [![CI](https://github.com/$USER/$REPO/workflows/CI/badge.svg?branch=master)](https://github.com/$USER/$REPO/actions?query=workflow%3ACI)
63+
# after replacing $USER/$REPO to use your project namespace; note also
64+
# that CI is the workflow name, defined at the beginning of this file.

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@
55
Demo of:
66

77
* [docker-coq-action](https://github.com/erikmd/docker-coq-action),
8-
* [Docker-Coq](https://hub.docker.com/r/coqorg/coq) images,
8+
* [docker-coq](https://hub.docker.com/r/coqorg/coq) and
9+
[docker-mathcomp](https://hub.docker.com/r/mathcomp/mathcomp) images,
910
* and a workflow named [build-coq-demo.yml](./.github/workflows/build-coq-demo.yml),
1011
* relying on [coq-demo.opam](./coq-demo.opam)
12+
13+
Note: you can add a badge in your `README.md`, like that of this demo:
14+
15+
```
16+
[![CI](https://github.com/$USER/$REPO/workflows/CI/badge.svg?branch=master)](https://github.com/$USER/$REPO/actions?query=workflow%3ACI)
17+
```
18+
19+
after replacing `$USER/$REPO` to use your project namespace; note also
20+
that CI is the workflow name, defined at the beginning of [this file](
21+
./.github/workflows/build-coq-demo.yml).

0 commit comments

Comments
 (0)