evocheck: add a README

2017-05-09 23:50:52 +02:00 · 2017-05-09 23:50:52 +02:00 · 92f12682d1
parent 8380b96864
commit 92f12682d1
1 changed files with 15 additions and 0 deletions
--- a/evocheck/README.md
+++ b/evocheck/README.md
@ -0,0 +1,15 @@
+# evocheck
+
+Install and run evocheck ; a script for checking various settings automatically.
+
+## Tasks
+
+The tasks in `main.yml` install the script. This is temporary as evocheck is a package on Debian which is a bit outdated for the moment. For OpenBSD, it should also be packaged, but the work is not done yet.
+
+A separate `exec.yml` file can be imported manually in playbooks or roles to execute the script. Example :
+
+```
+- include_role:
+    name: evocheck
+    tasks_from: exec.yml
+```