From fe986dbecd202b8d21fd8e68083ebaa9bc4c7b49 Mon Sep 17 00:00:00 2001
From: Laurent Modolo <laurent@modolo.fr>
Date: Tue, 5 Nov 2019 10:43:23 +0100
Subject: [PATCH] README.md: put list of available tools in another file

---
 README.md              | 36 +-----------------------------------
 doc/available_tools.md | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+), 35 deletions(-)
 create mode 100644 doc/available_tools.md

diff --git a/README.md b/README.md
index 29df9eea..3b2c8d6b 100644
--- a/README.md
+++ b/README.md
@@ -17,41 +17,7 @@ These instructions will get you a copy of the project up and running on your loc
 
 ## Available tools
 
-| tool | nf module | docker module | psmn module |
-|------|:---------:|:-------------:|:----------:|
-BEDtools | ok | ok | ok
-BFCtools |**no**  | ok | ok
-bioawk |**no**  | ok | ok
-Bowtie | ok | ok | **no**
-Bowtie2 | ok | ok | ok
-BWA | ok | ok | ok
-canu | ok | ok | ok
-cutadapt | ok | ok | ok
-deepTools | ok | ok | ok
-fastp | ok | ok | ok
-FastQC | ok | ok | ok
-file_handle | **no** | ok | ok
-GATK | **no** | ok | ok
-HISAT2 | ok | ok | ok
-HTSeq | ok | ok | ok
-Kallisto | ok | ok | ok
-MACS2 | ok | ok | ok
-MultiQC | ok | ok | ok
-MUSIC | ok | ok | ok
-picard | **no** | ok | ok
-pigz | **no** | ok | ok
-RSEM | ok | ok | ok
-Salmon | **no** | ok | ok
-sambamba | ok | ok | ok
-samblaster | ok | ok | ok
-SAMtools | ok | ok | ok
-SRAtoolkit | ok | ok | ok
-subread | **no** | ok | ok
-TopHat | **no** | ok | ok
-Trimmomatic | **no** | ok | ok
-UMItools  | **no** | ok | ok
-UrQt | ok | ok | ok
-
+[The list of available tools.](doc/available_tools.md)
 
 ## Contributing
 
diff --git a/doc/available_tools.md b/doc/available_tools.md
new file mode 100644
index 00000000..10b97ea3
--- /dev/null
+++ b/doc/available_tools.md
@@ -0,0 +1,41 @@
+## Available tools
+
+- **nf module**: a working example of nextflow process is available in `src/nf_modules/<tools>/<tool>.nf` and `src/nf_modules/<tools>/<tool>.config`
+- **docker module**: you can create a docker with the `src/docker_modules/<tool>/<version>/docker_init.sh`
+- **psmn module**: you can use the tool in the PSMN
+- **IN2P3 module**: you can use the tool in the CCIN2P3
+
+| tool | nf module | docker module | psmn module | in2p3 module |
+|------|:---------:|:-------------:|:-----------:|:-------------:|
+BEDtools | ok | ok | ok | ok 
+BFCtools |**no**  | ok | ok | ok
+bioawk |**no**  | ok | ok | ok
+Bowtie | ok | ok | **no** | ok
+Bowtie2 | ok | ok | ok | ok
+BWA | ok | ok | ok | ok
+canu | ok | ok | ok | ok
+cutadapt | ok | ok | ok | ok
+deepTools | ok | ok | ok | ok
+fastp | ok | ok | ok | ok
+FastQC | ok | ok | ok | ok
+file_handle | **no** | ok | ok | ok
+GATK | **no** | ok | ok | ok
+HISAT2 | ok | ok | ok | ok
+HTSeq | ok | ok | ok | ok
+Kallisto | ok | ok | ok | ok
+MACS2 | ok | ok | ok | ok
+MultiQC | ok | ok | ok | ok
+MUSIC | ok | ok | ok | ok
+picard | **no** | ok | ok | ok
+pigz | **no** | ok | ok | ok
+RSEM | ok | ok | ok | ok
+Salmon | **no** | ok | ok | ok
+sambamba | ok | ok | ok | ok
+samblaster | ok | ok | ok | ok
+SAMtools | ok | ok | ok | ok
+SRAtoolkit | ok | ok | ok | ok
+subread | **no** | ok | ok | ok
+TopHat | **no** | ok | ok | ok
+Trimmomatic | **no** | ok | ok | ok
+UMItools  | **no** | ok | ok | ok
+UrQt | ok | ok | ok | ok
-- 
GitLab