From 077548e655f4875221da209d2677e580205bf5f5 Mon Sep 17 00:00:00 2001 From: Bernhard Posselt Date: Mon, 29 Apr 2013 15:43:35 +0200 Subject: prepare readme for beta release --- README.rst | 28 +++++++++++++++++++++------- appinfo/info.xml | 2 -- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index e2e344e92..6fd819444 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ README ====== -The News app is a an rss/atom feed aggregator. It is based on the library SimplePie. +The News app is a an RSS/Atom feed aggregator. It is based on the library SimplePie. Maintainers ----------- @@ -10,9 +10,7 @@ Maintainers Status ------ -The app is in alpha status and can be tested. - -See the `beta milestone in the bugtracker `_ for more information on progress +Beta Bugs ---- @@ -23,16 +21,32 @@ Before reporting bugs: * get the newest version of the News app * `check if they already have been reported `_ + Before you install the News app ------------------------------- Before you install the app check that the following requirements are met: -- Your database uses utf-8 -- Your webserver uses utf-8 (`Apache `_, `NginX `_) - `Magic quotes are turned off `_ - `You use a browser that supports the FileReader API `_ - You can use a cron or webcron to call Background Jobs in ownCloud -- (optional) install php-curl +- You have installed **php-curl** and activated it in the **php.ini** +- Install ownCloud **5.0.5** (important! comes with required CSS styles) + +Should you have upgraded from a prior version, disable the CSS and JavaScript caching by adding this to :file:`owncloud/config/config.php`:: + + DEFINE('DEBUG', true); + +How to install the News app from the App Store +---------------------------------------------- + +- Go to the ownCloud apps page +- Activate the App Framework App first, then activate the News app in the apps menu + +- `Set up ownCloud Background Jobs `_ to enable feed updates. A recommended timespan for feed updates is 15-30 Minutes. + +How to keep up to date +---------------------- +Simply disable and reenable the **News** and **App Framework** App again (ownCloud deletes the app if its not shipped by default) How to install the News app from Git ------------------------------------ diff --git a/appinfo/info.xml b/appinfo/info.xml index 56f5faa7e..e66619daa 100644 --- a/appinfo/info.xml +++ b/appinfo/info.xml @@ -4,8 +4,6 @@ News An RSS/Atom feed reader AGPL - true Alessandro Cosentino, Bernhard Posselt, Jan-Christoph Borchardt. Powered by SimplePie (Ryan Parman, Geoffrey Sneddon, Ryan McCue and contributors). 5 - -- cgit v1.2.3