Added link to example files to the docs and README

fpgmaas · Mar 25, 2023 · 1d0fa3b · 1d0fa3b
1 parent c3227f0
commit 1d0fa3b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,13 @@ _ckit_ is a command line utility to help you organise and quickly run frequently
 <img src="docs/static/ckit.gif"/>
 </p>
 
+---
+<p align="center">
+  <a href="https://fpgmaas.github.io/ckit">Documentation</a> - <a href="https://github.com/fpgmaas/ckit-files/">Example configuration files</a>
+</p>
+
+---
+
 ## Quickstart
 
 ### Installation

diff --git a/docs/index.md b/docs/index.md
@@ -17,6 +17,12 @@ _ckit_ is a command line utility to help you organise and quickly run frequently
 <img src="static/ckit.gif"/>
 </p>
 
+---
+<p align="center">
+<a href="https://github.com/fpgmaas/ckit-files/">Example configuration files</a>
+</p>
+
+---
 ## Quickstart
 
 ### Installation
@@ -43,6 +49,10 @@ ckit
 
 For details regarding the configuration files, see the [configuration](https://fpgmaas.github.io/ckit/configuration) section of the documentation.
 
+## Examples
+
+For a list of example configuration files, see [ckit-files](https://github.com/fpgmaas/ckit-files).
+
 ---
 
 Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).