diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-14 20:30:52 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-14 20:30:52 -0500 |
| commit | 033ef570a1af02d0d1c28beec60df5349edcb2ca (patch) | |
| tree | 3214bb7b9f21d261798809736d83596d8a02a935 | |
| parent | d509e2193aa27a920b2cb423479f4878931c3dfc (diff) | |
| download | selfhosted-033ef570a1af02d0d1c28beec60df5349edcb2ca.tar.gz selfhosted-033ef570a1af02d0d1c28beec60df5349edcb2ca.zip | |
nim: add docs
| -rw-r--r-- | roles/nim/README.md | 24 |
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 +```` |