Nouvelle tentative de correction des rappels d'adhésion

[gestion-adh.git] / README

diff --git a/README b/README
index 6d03e990af49dc1ce2180b71d6718901eedf537f..48ab9a22d7a45f4dab93a149ef9273bb2468bbbb 100644 (file)
--- a/README
+++ b/README
@@ -8,9 +8,8 @@ adhésions de Nos oignons conformément aux statuts de l'association.
 Base des membres
 ================
 
 Base des membres
 ================
 

-La base des membres est pensée pour être stockés dans le wiki du conseil
-d'administration. Elle est formée sous forme d'une série de pages, une par
-membre.
+La base des membres est pensée pour être stockée dans le wiki du conseil
+d'administration. Elle est formée d'une série de pages, une par membre.

 
 Cela donne l'aboresence suivante :
 
 
 Cela donne l'aboresence suivante :
 


@@ -43,13 +42,17 @@ suivantes :
 
 =`name`=
     Le nom (complet) du membre.
 
 =`name`=
     Le nom (complet) du membre.

+

 =`address`=
     L'adresse postale du membre.
 =`address`=
     L'adresse postale du membre.

+

 =`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.
 =`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.
 =`joined_on`=
     Date d'adhésion à l'association.

+

 =`membership_fee_paid_on`=
     Date du paiement de la dernière cotisation.
 
 =`membership_fee_paid_on`=
     Date du paiement de la dernière cotisation.
 


@@ -66,7 +69,7 @@ fonctionalités respectives en lisant les cas d'utilisation dans les fichiers
 
 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
 
 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
+cette dernière n'est pas spécifiée, 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.
 
 `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.
 


@@ -87,7 +90,7 @@ C.A. (en faisant un lien symbolique dans `.git/hooks/pre-commit`).
 `pre-receive-hook`
 ------------------
 
 `pre-receive-hook`
 ------------------
 

-`pre-commit` hook pour Git. Ce dernier est là pour éviter de pouvoir enregistrer
+`pre-receive` hook pour Git. Ce dernier est là pour éviter de pouvoir enregistrer

 des informations invalides dans la base des membres. Il doit être configuré dans
 le dépôt central du wiki du C.A. (via un lien symbolique dans
 `.git/hooks/pre-receive`).
 des informations invalides dans la base des membres. Il doit être configuré dans
 le dépôt central du wiki du C.A. (via un lien symbolique dans
 `.git/hooks/pre-receive`).


@@ -95,19 +98,19 @@ le dépôt central du wiki du C.A. (via un lien symbolique dans
 `update-ag-subscribers`
 -----------------------
 
 `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`.
+Met à jour la liste des adresses email 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.
 
 
 `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`.
+Le fichier utilisé pour garder la liste des envois déjà effectués est soit
+celui indiqué par la variable d'environnement `NOS_OIGNONS_REMINDER_DB`, soit
+le fichier `var/reminders.yaml` si la variable est vide.

 
 `send-member-emails-to-advisors`
 --------------------------------
 
 `send-member-emails-to-advisors`
 --------------------------------


@@ -119,7 +122,7 @@ Ce script a vocation a être executé tous les mois afin que le comité
 puisse convoquer une assemblée générale extraordinaire, même en cas de
 défaillance du conseil d'administration.
 
 puisse convoquer une assemblée générale extraordinaire, même en cas de
 défaillance du conseil d'administration.
 

-`create-membership-fee-reciept`
+`create-membership-fee-receipt`

 -------------------------------
 
 Permet de créer un reçu de cotisation pour les membres en faisant
 -------------------------------
 
 Permet de créer un reçu de cotisation pour les membres en faisant


@@ -127,26 +130,26 @@ la demande.
 
 Exemple d'utilisation :
 
 
 Exemple d'utilisation :
 

-    bin/create-membership-fee-reciept 000042 10,00
+    bin/create-membership-fee-receipt 000042 10,00

 
 

-Cela crééra un reçu pour le membre 000042 pour une cotisation d'un
-montant de 10,00€. Le reçu est généré sous forme d'un fichier PDF dans
-le répertoire spécifié par la variable d'environnement NOS_OIGNONS_RECIEPTS_DIR
-(ou le répertoire `reciepts` dans le répertoire courant).
+Cela crééra un reçu pour le membre 000042 pour une cotisation d'un montant
+de 10,00€. Le reçu est généré sous forme d'un fichier PDF dans le répertoire
+spécifié par la variable d'environnement NOS_OIGNONS_RECEIPTS_DIR (ou le
+répertoire `receipts` dans le répertoire courant).

 
 

-Il faut créer le répertoire avant utilisation s'il n'existe pas déjà.
+**Il faut créer le répertoire avant utilisation s'il n'existe pas déjà.**

 
 Développement
 =============
 
 
 Développement
 =============
 

-L'essentiel du code est en Ruby. Les dépendences sont gérés avec Bundler. Les
-tests d'intégrations sont fait avec Cucumber.
+L'essentiel du code est en Ruby. Les dépendances sont gérées avec Bundler. Les
+tests d'intégrations sont faits avec Cucumber.

 
 Installer les paquets Debian qui vont bien (sur Wheezy) :
 
     apt-get install ruby1.9.1 bundler
 
 
 Installer les paquets Debian qui vont bien (sur Wheezy) :
 
     apt-get install ruby1.9.1 bundler
 

-Pour récupérer les dépendences :
+Pour récupérer les dépendances :

 
     ruby1.9.1 /usr/bin/bundle install --path=vendor/bundle
 
 
     ruby1.9.1 /usr/bin/bundle install --path=vendor/bundle
 


@@ -157,7 +160,7 @@ Installer les paquets Debian qui vont bien (sur Wheezy) :
 
     apt-get install ruby1.9.1 bundler
 
 
     apt-get install ruby1.9.1 bundler
 

-Installer les dépendences :
+Installer les dépendances :

 
     ruby1.9.1 /usr/bin/bundle install --deployment \
                                       --without=development \
 
     ruby1.9.1 /usr/bin/bundle install --deployment \
                                       --without=development \