Correction ('reçu' ou 'récépissé' se dit 'receipt' en anglais, et non

[gestion-adh.git] / README

diff --git a/README b/README
index 9992f82b91dbe84350cfbfb5cfddaef94db488b2..f0eb47eedbe4db5618f1e781ff4acf7c1ba608f2 100644 (file)
--- a/README
+++ b/README
@@ -109,6 +109,33 @@ 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`.
 
 celui indiqué par la variable d'environnement `NOS_OIGNONS_REMINDER_DB`, ou
 le fichier si elle est vide `var/reminders.yaml`.
 

+`send-member-emails-to-advisors`
+--------------------------------
+
+Envoie la liste des emails des membres à jour de cotisation au comité
+de déontologie.
+
+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.
+
+`create-membership-fee-receipt`
+-------------------------------
+
+Permet de créer un reçu de cotisation pour les membres en faisant
+la demande.
+
+Exemple d'utilisation :
+
+    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_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à.
+

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


@@ -137,6 +164,8 @@ Installer les dépendences :
                                       --path=vendor/bundle
     chmod -R o+rX vendor/bundle
 
                                       --path=vendor/bundle
     chmod -R o+rX vendor/bundle
 

+Il faut donner les droits d'écriture à `wiki-ca` sur le répertoire `var`.
+

 Pour rendre facilement accessible `list-members-emails`, on peut ajouter dans
 `/usr/local/bin` un mini script tel que celui-ci :
 
 Pour rendre facilement accessible `list-members-emails`, on peut ajouter dans
 `/usr/local/bin` un mini script tel que celui-ci :
 


@@ -163,6 +192,7 @@ Ensuite, pour exécuter régulièrement les scripts via le *crontab* du compte
 
     42 * * * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/update-ag-subscribers
     42 6 * * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/send-membership-reminders
 
     42 * * * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/update-ag-subscribers
     42 6 * * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/send-membership-reminders

+    21 0 1 * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/send-member-emails-to-advisors

 
 Pour installer le `pre-commit` *hook* sur le dépôt utilisé par
 Ikiwiki, on met dans `/srv/ikiwiki/wiki-ca/src/.git/hooks/pre-commit` :
 
 Pour installer le `pre-commit` *hook* sur le dépôt utilisé par
 Ikiwiki, on met dans `/srv/ikiwiki/wiki-ca/src/.git/hooks/pre-commit` :