aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2020-08-11 18:57:01 +0200
committerYann Herklotz <git@yannherklotz.com>2020-08-11 18:57:01 +0200
commite4ab2d9191c8bd10b70ed37b52d7e858bcea042c (patch)
tree9db84afb2350c9135facf1fc49d28d6db7ee080b
parenteea5ca4078823230ff3a20cb1f7ec1cd541d2713 (diff)
downloadvericert-e4ab2d9191c8bd10b70ed37b52d7e858bcea042c.tar.gz
vericert-e4ab2d9191c8bd10b70ed37b52d7e858bcea042c.zip
Add documentation badge to README
-rw-r--r--.github/workflows/gh-pages.yml2
-rw-r--r--README.md3
-rw-r--r--scripts/output.svg1
-rw-r--r--scripts/statistics.py2
4 files changed, 4 insertions, 4 deletions
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
index d812477..ed7e032 100644
--- a/.github/workflows/gh-pages.yml
+++ b/.github/workflows/gh-pages.yml
@@ -1,4 +1,4 @@
-name: Documentation
+name: docs
on:
push:
diff --git a/README.md b/README.md
index 358f997..26a1931 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
# Vericert
-![CI](https://github.com/ymherklotz/vericert/workflows/CI/badge.svg)
+[![CI](https://github.com/ymherklotz/vericert/workflows/CI/badge.svg)](https://github.com/ymherklotz/vericert/actions)
+[![docs](https://github.com/ymherklotz/vericert/workflows/docs/badge.svg)](https://ymherklotz.github.io/vericert)
![Admitted](https://raw.githubusercontent.com/ymherklotz/vericert/gh-pages/assets/admitted.svg)
A formally verified high-level synthesis (HLS) tool written in Coq, building on top of [CompCert](https://github.com/AbsInt/CompCert). This ensures the correctness of the C to Verilog translation according to our Verilog semantics and CompCert's C semantics, removing the need to check the resulting hardware for behavioural correctness.
diff --git a/scripts/output.svg b/scripts/output.svg
deleted file mode 100644
index 8829659..0000000
--- a/scripts/output.svg
+++ /dev/null
@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="122" height="20" role="img" aria-label="Admitted Proofs: 99"><title>Admitted Proofs: 99</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="122" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="99" height="20" fill="#555"/><rect x="99" width="23" height="20" fill="#fe7d37"/><rect width="122" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="505" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="890">Admitted Proofs</text><text x="505" y="140" transform="scale(.1)" fill="#fff" textLength="890">Admitted Proofs</text><text aria-hidden="true" x="1095" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="130">99</text><text x="1095" y="140" transform="scale(.1)" fill="#fff" textLength="130">99</text></g></svg> \ No newline at end of file
diff --git a/scripts/statistics.py b/scripts/statistics.py
index 9ec460d..f3db9ff 100644
--- a/scripts/statistics.py
+++ b/scripts/statistics.py
@@ -31,7 +31,7 @@ def main(d):
n_admitted, n_theorems, _ = collect(d)
colour = pick_colour(n_admitted, n_theorems)
- url = "https://img.shields.io/badge/Admitted%20Proofs-{}-{}?style=flat".format(
+ url = "https://img.shields.io/badge/admitted%20proofs-{}-{}?style=flat".format(
str(n_admitted), colour)
req = urllib.request.Request(url, headers={"User-Agent": "Mozilla/5.0"})