add doc

diff --git a/import.sh b/import.sh
index f4983fdb9e233c6af52e4cc37662d51589d9ca4f..0021740dab5149d08dc309797c465591933815c3 100755 (executable)
--- a/import.sh
+++ b/import.sh
@@ -26,6 +26,18 @@ origin="$HOME/Documents/partages/"
 folders="moocs confs"
 dest="nec/"
 
+################################################################################
+# Vérifie si un fichier distant existe déjà ou pas. L'importe s'il est nouveau
+# ou s'il a été modifié; ne fait rien sinon.
+#
+# Globals:
+#     $origin: le chemin où se trouve les fichiers
+#     $dest: le dossier local où seront importés les fichiers
+#     $red/$blue/$green/$reset: les couleurs
+# Arguments:
+#     $1: le chemin du fichier à vérifier / importer
+#         ex: /home/X/Documents/partages/confs/fichier.org 
+################################################################################
 check ()
 {
     tmp=${1/$origin/$dest} # nouveau chemin