FreshRSS/README

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 <dev@marienfressinaud.fr>
@version 0.2.0
@date 2013-04-17
@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) ou par mail

De plus, je n'ai réellement testé FreshRSS que sous Firefox, il pourrait y
avoir des soucis sur d'autres navigateurs.

PRE-REQUIS
==========
- Serveur Apache (non testé sur aucun autre)
- PHP 5.3 (il me faudrait des retours sur d'autres versions antérieures)
- libxml pour PHP
- cURL
- PDO et MySQL

INSTALLATION
============
	1. Récupérez l'application FreshRSS via la commande git ou en
	   téléchargeant l'archive
	2. Exécutez le script ./build.sh ou en récupérant à la main la librairie
	   Minz (https://github.com/marienfressinaud/MINZ) et en copian la lib
	   dans /lib/minz
	3. Déplacez l'application où vous voulez sur votre serveur (attention,
	   la partie accessible se trouve dans le répertoire `/public`)
	4. Accéder à FreshRSS à travers votre navigateur web et suivez les
	   instructions !
	5. 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. Le fichier de log peut être utile à lire si vous avez des soucis
	3. Le fichier `/public/index.php` défini les chemins d'accès aux
	   répertoires clés de l'application. Si vous les bougez, tout se passe
	   ici.
	4. Vous pouvez ajouter une tâche CRON sur l'url de mise à jour des flux
	   (clic droit sur le bouton d'actualisation puis "Copier l'adresse du
	   lien") pour que celle-ci se fasse de manière transparente

CHANGELOG
=========
2013-04-17 changes with FreshRSS 0.2.0
	*) Création d'un installateur
	*) Actualisation des flux en Ajax
	*) Partage par mail et Shaarli ajouté
	*) Export par flux RSS
	*) Possibilité de vider une catégorie
	*) Possibilité de sélectionner les catégories en vue mobile
	*) Les flux peuvent être sortis du flux principal (système de priorité)
	*) Amélioration ajout / import / export des flux
	*) Amélioration actualisation (meilleure gestion des erreurs)
	*) Améliorations CSS
	*) Changements dans la base de données
	*) Màj de la librairie SimplePie
	*) Flux sans auteurs gérés normalement
	*) Correction bugs divers

2013-04-08 changes with FreshRSS 0.1.0
	*) "Première" version