diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 10 insertions, 13 deletions
@@ -9,26 +9,23 @@ It is a multi-user application with an anonymous reading mode. * Official website: http://freshrss.org * Demo: http://demo.freshrss.org/ -* Developer: Marien Fressinaud <dev@marienfressinaud.fr> -* Current version: 0.9.4 -* Publication date: 2015-01-15 -* License [GNU AGPL 3](http://www.gnu.org/licenses/agpl-3.0.html) +* License: [GNU AGPL 3](http://www.gnu.org/licenses/agpl-3.0.html)  # Note on branches **This application is still in development!** Please use the branch that suits your needs: -* Use [the master branch](https://github.com/marienfressinaud/FreshRSS/tree/master/) if you need a stable version. -* [The beta branch](https://github.com/marienfressinaud/FreshRSS/tree/beta) is the default branch: new features are added on a monthly basis. -* For developers and tech savvy persons, [the dev branch](https://github.com/marienfressinaud/FreshRSS/tree/dev) is waiting for you! +* Use [the master branch](https://github.com/FreshRSS/FreshRSS/tree/master/) if you need a stable version. +* [The beta branch](https://github.com/FreshRSS/FreshRSS/tree/beta) is the default branch: new features are added on a monthly basis. +* For developers and tech savvy persons, [the dev branch](https://github.com/FreshRSS/FreshRSS/tree/dev) is waiting for you! # Disclaimer This application was developed to fulfill personal needs not professional needs. There is no guarantee neither on its security nor its proper functioning. If there is feature requests which I think are good for the project, I'll do my best to include them. The best way is to open issues on GitHub -(https://github.com/marienfressinaud/FreshRSS/issues) or by email (dev@marienfressinaud.fr) +(https://github.com/FreshRSS/FreshRSS/issues). # Requirements * Light server running Linux or Windows @@ -37,14 +34,14 @@ The best way is to open issues on GitHub * PHP 5.2.1+ (PHP 5.3.7+ recommanded) * Required extensions: [PDO_MySQL](http://php.net/pdo-mysql) or [PDO_SQLite](http://php.net/pdo-sqlite), [cURL](http://php.net/curl), [GMP](http://php.net/gmp) (only for API access on platforms under 64 bits) * Recommanded extensions : [JSON](http://php.net/json), [mbstring](http://php.net/mbstring), [zlib](http://php.net/zlib), [Zip](http://php.net/zip) -* MySQL 5.0.3+ (recommanded) ou SQLite 3.7.4+ +* MySQL 5.0.3+ (recommanded) or SQLite 3.7.4+ * A recent browser like Firefox 4+, Chrome, Opera, Safari, Internet Explorer 9+ * Works on mobile  # Installation -1. Get FreshRSS with git or [by downloading the archive](https://github.com/marienfressinaud/FreshRSS/archive/master.zip) +1. Get FreshRSS with git or [by downloading the archive](https://github.com/FreshRSS/FreshRSS/archive/master.zip) 2. Dump the application on your server (expose only the `./p/` folder) 3. Add write access on `./data/` folder to the webserver user 4. Access FreshRSS with your browser and follow the installation process @@ -70,9 +67,9 @@ For example, if you want to run the script every hour: # Advices * For a better security, expose only the `./p/` folder on the web. - * Be aware that the `./data/` folder contain all personal data, so it is a bad idea to expose it. -* The `./constants.php` file define access to application folder. If you want to customize your installation, every thing happens here. -* If you encounter some problem, logs are accessibles from the interface or manually in `./data/log/*.log` files. + * Be aware that the `./data/` folder contains all personal data, so it is a bad idea to expose it. +* The `./constants.php` file defines access to application folder. If you want to customize your installation, every thing happens here. +* If you encounter any problem, logs are accessibles from the interface or manually in `./data/log/*.log` files. # Backup * You need to keep `./data/config.php`, `./data/*_user.php` and `./data/persona/` files |