diff --git a/modules/template b/modules/template index fc5ace3..c031e60 100644 --- a/modules/template +++ b/modules/template @@ -1,48 +1,44 @@ -# Template générique à utiliser comme modèle pour de nouveaux modules # +# Generic templateque to use as a model for new modules creation # # # -# !!! ATTENTION : les modules ne sont pas supposé contenir de code spécifique # -# !!! pour une distribution ou une autre. Utiliser les fichiers de # -# !!! configurations pour introduire du code spécifique. # +# !!! ATTENTION : modules are not supposed to contains any specific code for # +# !!! a distribution or a other. Please use configuration files # +# !!! to introduce any specific code. # # # -# @template@ doit être remplacé par le nom de votre module qui doit être nomé # -# @template@.sh. Vous pouvez automatiquement créer votre nouveau module avec # -# la commande suivante : # +# @template@ must be replaced by the name of your module. It have to be named # +# @template@.sh. You can automaticallly create your new module using the # +# following command : # # # -# sed -e "s/@template@/nom_module/g" -e "/^# .*/d" -e "s/^##/# /" template > nom_module.sh +# sed -e "s/@template@/mod_name/g" -e "/^# .*/d" -e "s/^##/# /" template > mod_name.sh # # -# La versionnage suit des règles standards. Numéroté ainsi en x.y.z : # -# * x : incrémenté en cas de transformation profonde ou ajouts majeurs # -# * y : incrémenté en cas d'ajout mineur de fonctionnalité # -# * z : incrémenté en cas de correctifs (+n correctifs => incrément de +n) # +# Versioning iis following standard rules. Numbered as x.y.z: # +# * x : increased on deep changes, rewrites or major additions # +# * y : increased on minor functionnality additions # +# * z : increased on fixes (+n fixes => increased by +n) # # # -# Tout changement dans le code implique un incrément des numéros de version # -# des fichiers concernés (sauf conf) ET un commit dans git. # -# # -##Description du module @template@ +##Description of module @template@ ##Copyright (c) Year Your Name ##------------------------------------------------------------------------------ -##This file is distributed under 3-clause BSD license. -##The complete license agreement can be obtained at: -##https://opensource.org/licenses/BSD-3-Clause +## ##------------------------------------------------------------------------------ ##Variable list: +## * : role explaination ##------------------------------------------------------------------------------ -# Version du module +##Module version export VER_@template@="0.0.1" -# Code du module +##Module's code @template@() { # Code } -# Code des vérifications préliminaires +##Preliminary checks code for the module precheck_@template@() { # Code } -# Les fonctions publiques doivent être exportés +##Public functions might be exported export -f @template@ export -f precheck_@template@