From 6357c0528d280c2628a1a7974819ace7bf288013 Mon Sep 17 00:00:00 2001 From: Laurent Modolo <laurent.modolo@ens-lyon.fr> Date: Tue, 19 Jun 2018 17:00:21 +0200 Subject: [PATCH] CONTRIBUTING.md: add config examples --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cdbe14d..3a343cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,6 +49,12 @@ sed -i `s/<existing_version>/<new_version>/g` <new_version>.lua To propose a new module, use an existing module as a template to build the corresponding `apps/<software>/<version>` and `modulefiles/<software>/<version>` directory. +You can look at the following modules to have examples of : + +- Python tools : [MultiQC install.sh](https://gitlab.biologie.ens-lyon.fr/PSMN/modules/blob/master/apps/MultiQC/install_1.0.sh) and [MultiQC .lua](https://gitlab.biologie.ens-lyon.fr/PSMN/modules/blob/master/modulefiles/MultiQC/1.0.lua) +- Compiled tools : [UrQt install.sh](https://gitlab.biologie.ens-lyon.fr/PSMN/modules/blob/master/apps/UrQt/install_d62c1f8.sh) +- Java tools : [Trimmomatic install.sh](https://gitlab.biologie.ens-lyon.fr/PSMN/modules/blob/master/apps/Trimmomatic/install_0.36.sh) and [nextflow .lua](https://gitlab.biologie.ens-lyon.fr/PSMN/modules/blob/master/modulefiles/nextflow/0.28.2.lua) + ## Making your module available to the LBMC To make your module available to the LBMC you must have a `install_<new_version>.sh` script working without errors on the E5 compilation servers and you must be able to load the correspond module and run it. -- GitLab