aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
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 /README.md
parenteea5ca4078823230ff3a20cb1f7ec1cd541d2713 (diff)
downloadvericert-e4ab2d9191c8bd10b70ed37b52d7e858bcea042c.tar.gz
vericert-e4ab2d9191c8bd10b70ed37b52d7e858bcea042c.zip
Add documentation badge to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
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.