aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--roles/nim/README.md24
1 files changed, 24 insertions, 0 deletions
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
+````