From: quidame Date: Sat, 14 Dec 2013 14:49:27 +0000 (+0100) Subject: Corrections orthographe/grammaire + mise en page et autres cosmétiques. X-Git-Url: https://nos-oignons.net/gitweb/gestion-adh.git/commitdiff_plain/be6a632a1da26943671b63a50b080ff10d830273 Corrections orthographe/grammaire + mise en page et autres cosmétiques. --- diff --git a/README b/README index af50f34..48ab9a2 100644 --- a/README +++ b/README @@ -8,9 +8,8 @@ adhésions de Nos oignons conformément aux statuts de l'association. 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 : @@ -43,13 +42,17 @@ suivantes : =`name`= Le nom (complet) 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. + =`joined_on`= Date d'adhésion à l'association. + =`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 -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. @@ -87,7 +90,7 @@ C.A. (en faisant un lien symbolique dans `.git/hooks/pre-commit`). `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`). @@ -95,19 +98,19 @@ le dépôt central du wiki du C.A. (via un lien symbolique dans `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. -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` -------------------------------- @@ -129,24 +132,24 @@ 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). +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 ============= -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 -Pour récupérer les dépendences : +Pour récupérer les dépendances : 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 -Installer les dépendences : +Installer les dépendances : ruby1.9.1 /usr/bin/bundle install --deployment \ --without=development \