From 3f1acc1d36ad8717416d96c47e73252b2620525e Mon Sep 17 00:00:00 2001
From: kraktus <56031107+kraktus@users.noreply.github.com>
Date: Fri, 10 Nov 2023 15:59:55 +0100
Subject: [PATCH] Add Github CI

Adapted from the bash snippet at the top of the README, needed it for https://github.com/bheisler/criterion.rs/pull/742.
---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 021cfb014..09ab7a70a 100644
--- a/README.md
+++ b/README.md
@@ -160,6 +160,18 @@ pages:
     - master
 ```
 
+For those using Github actions, include the following snippet before running `mdbook build`
+```yaml
+      - name: Install latest linkcheck
+        run: |
+          mkdir -p mdbook-linkcheck && \
+          curl -L https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest/download/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip -o mdbook-linkcheck/mdbook-linkcheck.zip && \
+          unzip -d ./mdbook-linkcheck mdbook-linkcheck/mdbook-linkcheck.zip && \
+          chmod +x mdbook-linkcheck/mdbook-linkcheck && \
+          echo `pwd`/mdbook-linkcheck >> $GITHUB_PATH
+```
+
+
 The [michaelfbryan/mdbook-docker-image][image] docker image is also available
 on Docker hub and comes with the latest version of `mdbook` and
 `mdbook-linkcheck` pre-installed.