From 033ef570a1af02d0d1c28beec60df5349edcb2ca Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Tue, 14 Feb 2023 20:30:52 -0500
Subject: nim: add docs

---
 roles/nim/README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 roles/nim/README.md

(limited to 'roles')

diff --git a/roles/nim/README.md b/roles/nim/README.md
new file mode 100644
index 0000000..173145d
--- /dev/null
+++ b/roles/nim/README.md
@@ -0,0 +1,24 @@
+Nim
+===
+
+Description
+-----------
+
+The `nim` role installs the [nim](https://nim-lang.org/) compiler. This is
+currently only used as a dependency of the [nitter](../nitter/) role.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable      | Default                               | Description
+--------------|---------------------------------------|------------
+`nim_version` | see [default vars](defaults/main.yml) | Version of `nim` to install
+
+This role **exports** the following variables:
+
+Variable          | Description
+------------------|------------
+`nim_install_dir` | Directory containing `nim` executables
+````
-- 
cgit