Modif du fichier README + l'application s'appellera désormais FreshRSS

1 files changed, 56 insertions, 1 deletions

diff --git a/README b/README
index 4d796243b..e7e5ad24c 100644
--- a/README
+++ b/README
@@ -1 +1,56 @@
-Un simple agrégateur de flux rss
+Un simple agrégateur de flux rss relativement léger et rapide par rapport aux
+mastodontes que sont RSSLounge et TinyTinyRSS
+
+@name FreshRSS
+@author Marien Fressinaud <contact@marienfressinaud.fr>
+@version 1.0 alpha
+@date 2012-10-28
+@license agpl3
+
+DISCLAIMER
+==========
+Cette application a été développée pour s'adapter à mes besoins personnels.
+Je ne garantis en aucun cas la sécurité de celle-ci, ni son bon fonctionnement
+sur un autre serveur que le mien. Je m'engage néanmoins à répondre dans la
+mesure du possible aux demandes d'évolution si celles-ci me semblent justifiées.
+Privilégiez pour cela des demandes sur GitHub
+(https://github.com/marienfressinaud/FreshRSS/issues)
+
+INSTALLATION
+============
+	1. Récupérez l'application FreshRSS via la commande git ou en
+	   téléchargeant l'archive
+	2. Déplacez la où vous voulez sur votre serveur (attention, la partie
+	   accessible de l'application se trouve dans le répertoire `/public`)
+	3. Modifiez le fichier `/app/configuration/application.ini`
+	   	a/ environment = "production" de préférence
+	   	b/ use_url_rewriting = true si vous pouvez utiliser
+	   	                       l'url_rewriting, false sinon
+	   	c/ sel_application = "un_truc_aléatoire" à vous de mettre ce que
+	   	                     vous voulez, mais ne le changez pas après
+	   	d/ base_url = "" le chemin qui mène au répertoire `public` à
+	   	                 partir du répertoire pointé par le nom de
+	   	                 domaine (pas de slash à la fin /!\)
+	   	e/ title = "FreshRSS" le nom de l'application
+	   	f/ [db] (host, user, password, base) les paramètres pour accéder
+	   	   à votre base de données mysql
+	4. Éxécutez le script MySQL `freshrss.sql` sur la table définie par le
+	   paramètre `base` dans votre base de données (à travers PhpMyAdmin
+	   par exemple)
+	5. Vérifiez les droits en lecture / écriture sur le répertoire de log
+	   (`/log`) et celui de cache (`/cache`) qui doivent pouvoir étre lu et
+	   écrit par le serveur, mais pas les autres
+	6. Tout devrait fonctionner :) En cas de problème, n'hésitez pas à me
+	   contacter !
+
+SÉCURITÉ ET CONSEILS
+====================
+	1. Si possible, faites pointer un sous-domaine sur le répertoire
+	   `/public`
+	2. Assurez-vous de ne laisser qu'un droit de lecture par le serveur sur
+	   le fichier `/app/configuration/application.ini` (personne d'autre ne
+	   doit avoir le droit d'y accéder !)
+	3. Le fichier de log peut être utile à lire si vous avez des soucis
+	4. Le fichier `/public/index.php` définie les chemins d'accès aux
+	   répertoires clés de l'application. Si vous les bougez, tout se passe
+	   ici.