Add missing fields to gemspec

[gestion-adh.git] / README

diff --git a/README b/README
index bc73c094bfa0bf0209b510c0bfa55179d596a67d..0aafd0a4a48bda823599b97bdf8e1780dc44d3b1 100644 (file)
--- a/README
+++ b/README
@@ -31,6 +31,7 @@ Chaque page doit ressembler à :
       42 rue du Fleuve
       12042 Essaiville
     email: violette@example.org
+    joined_on: 2013-05-25
     membership_fee_paid_on: 2013-05-25
     ---
 
@@ -47,6 +48,8 @@ suivantes :
 =`email`=
     L'adresse email du membre. C'est à cette adresse que seront envoyés les
     messages de l'assemblée générale et les rappels de cotisation.
+=`joined_on`=
+    Date d'adhésion à l'association.
 =`membership_fee_paid_on`=
     Date du paiement de la dernière cotisation.
 
@@ -61,6 +64,12 @@ Voici le détail des scripts utilisés. On peut se faire une idée de leurs
 fonctionalités respectives en lisant les cas d'utilisation dans les fichiers
 `features/*.feature`.
 
+Le chemin vers la racine du clone du wiki du conseil d'amnisitration est
+spécifié par la variable d'environnement `NOS_OIGNONS_BOARD_WIKI_PATH`. Si
+cette dernière n'est pas spécifié, les scripts cherchent un répertoire
+`Membres` à la racine du Git courant, et si ce n'est pas le cas, dans
+le répertoire `wiki-ca` du répertoire parent du Git courant.
+
 `list-email`
 ------------
 
@@ -83,6 +92,23 @@ des informations invalides dans la base des membres. Il doit être configuré da
 le dépôt central du wiki du C.A. (via un lien symbolique dans
 `.git/hooks/pre-receive`).
 
+`update-ag-subscribers`
+-----------------------
+
+Met à jour la liste des emails inscrites à la liste ag@ par rapport aux membres
+à jour de cotisation. À exécuter à travers un *cron*. A besoin de pouvoir
+lancer les commandes `list_members`, `add_members` et `remove_members` via
+`sudo` sur le compte `list`.
+
+`send-membership-reminders`
+---------------------------
+
+Préviens les membres qu'il faut renouveller leur cotisation.
+
+Le fichier utiliser pour garder la liste des envois déjà effectués est soit
+celui indiqué par la variable d'environnement `NOS_OIGNONS_REMINDER_DB`, ou
+le fichier si elle est vide `var/reminders.yaml`.
+
 Développement
 =============
 
@@ -112,3 +138,6 @@ Installer les dépendences :
 
 Il faut ensuite mettre en place le lien symbolique vers le script
 `pre-receive-hooks`. XXX: à détailler
+
+XXX: configuration sudoers
+XXX: crontab pour update-ag-subscribers