From 7d24d76fbe5b72ff986e7facb881e04852e5aa54 Mon Sep 17 00:00:00 2001
From: kehillio <kenzo-hugo.hillion1@pasteur.fr>
Date: Fri, 10 May 2019 16:48:46 +0200
Subject: [PATCH] continue README for tool descriptions

---
 tools/README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/tools/README.md b/tools/README.md
index fe6c1a2..8fce077 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -9,10 +9,13 @@ example file (usually containing default parameters that are set up on the `.rul
 
 All Snakemake tool descriptions try to respect some rules and best practices in their design:
 
-* First part correspond to all options that are set up from a `config.yaml` file
+* First part correspond to all options that are set up from a `config.yaml` file. They all have the nomenclature `__TOOLNAME_variable`.
 * Then the tool itself is described with:
   * input with the nomenclature: `__TOOLNAME_input`
   * output with the nomenclature: ` __TOOLNAME_output`
   * params with different options that are described above
+  	* There is usually a `exec_command` to give the possibility to change the way the tool is called (locally installed, singularity ...)
+  	* There is usually a `options` to specify all other command line options
+  * the shell command
 
 input and output are then set up in the Snakemake file that refer to the rule.
\ No newline at end of file
-- 
GitLab