From fec2f7dc64a65443cfa49be554fc025e875ede30 Mon Sep 17 00:00:00 2001 From: "V.Krishn" Date: Tue, 28 Jan 2020 00:19:23 +0530 Subject: update docs --- README.md | 30 +++++++++++------------------- TODO | 13 ------------- TODO.md | 17 +++++++++++++++++ VERSION | 2 +- config/readme.notes | 9 +++++++++ doc/install.md | 29 +++++++++-------------------- 6 files changed, 47 insertions(+), 53 deletions(-) delete mode 100644 TODO create mode 100644 TODO.md diff --git a/README.md b/README.md index e01b197..0000655 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,20 @@ Rss reader *(web based)* for Newsbeuter. -_NOTE: Alpha-release_ +_NOTE: Beta-release_ :Author: vkrishn@insteps.net -:Date: 2015-10-23 -:Version: 0.1.2 +:Date: 2020-10-23 +:Version: 0.2.0-beta1 #### Table of Contents 1. [Features](#features) -2. [Features (todo)](#features-todo) -3. [Why a hybrid application](#why-a-hybrid-application) -4. [Requirements / Dependencies](#requirements--dependencies) -5. [Reference](#reference) -6. [Limitations - OS compatibility, etc.](#limitations) -7. [Development - Guide for contributing to the module](#development) +2. [Why a hybrid application](#why-a-hybrid-application) +3. [Requirements / Dependencies](#requirements--dependencies) +4. [Reference](#reference) +5. [Limitations - OS compatibility, etc.](#limitations) +6. [Development - Guide for contributing to the module](#development) ## Features @@ -34,14 +33,6 @@ _NOTE: Alpha-release_ ![Layout](http://dev1.insteps.net/nbreader/layout-features.png) -## Features (TODO) - -1. Add way to mark/filter articles, eg. flag, tag and bookmark. -2. Improve search on active rss (all pages). -3. Special folders. -4. Browser based settings/configs to run update/changes on backend. -5. ... - ![Layout](http://dev1.insteps.net/nbreader/layout-alpha-todo.png) ## Why a hybrid application @@ -52,14 +43,15 @@ _NOTE: Alpha-release_ ## Requirements / Dependencies -1. Newsbeuter +1. Newsbeuter (or Newsboat, make link for Newsbeuter) 2. Sqlite3 3. Curl(default) or Wget 4. PHP 5.4+ 5. Any PHP supporting web-server (tested on Apache with .htaccess file support). 6. CodeIgniter-3.x (PHP Framework) 7. File (for icon download) -8. Fossil scm, https://www.fossil-scm.org (optional), +8. Git/Fossil scm, (optional), + url: https://www.fossil-scm.org (optional), easy way is download the precompiled single binary file. 9. Jq (optional) 10. diff --git a/TODO b/TODO deleted file mode 100644 index 9801f8e..0000000 --- a/TODO +++ /dev/null @@ -1,13 +0,0 @@ - - -* single feed's combined pages search in browser -* feed's favicon support -* global search in browser -* make scripts more modular -* convert old newsbeuter db to nbreader compatible format -* make use of http2/web2.0 features -* use require.js/angular.js if necessary -* make use of jsonapi.org -* make use of www.w3.org/2013/csvw/wiki/ where possible - - diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..a15de00 --- /dev/null +++ b/TODO.md @@ -0,0 +1,17 @@ + +## Features (TODO) + +* single feed's combined pages search in browser +* global search in browser +* make scripts more modular +* convert old newsbeuter db to nbreader compatible format +* make use of http2/web2.0 features +* use require.js/angular.js if necessary +* make use of jsonapi.org +* make use of www.w3.org/2013/csvw/wiki/ where possible + +* Add way to mark/filter articles, eg. flag, tag and bookmark. +* Improve search on active rss (all pages). +* Special folders. +* Browser based settings/configs to run update/changes on backend. +... diff --git a/VERSION b/VERSION index d917d3e..8d453c4 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.1.2 +0.2.0-beta1 diff --git a/config/readme.notes b/config/readme.notes index afcfd22..e9cae9f 100644 --- a/config/readme.notes +++ b/config/readme.notes @@ -8,7 +8,16 @@ 4. Some files/directory are generated in config folder, i.e baseurl, dbname, urls.db, url.local + DO NOT ALTER OR DELETE THEM + If they are missing or corrupted run `config.sh` to regenerate them again. + For every url list-file in `config/url.local` + there should be a generated database file + in `var/newsbeuter/db/`. + + eg. for file `config/url/news` the database file + would be `var/newsbeuter/db/news.loc.db` + diff --git a/doc/install.md b/doc/install.md index 4f14762..e8c9d60 100644 --- a/doc/install.md +++ b/doc/install.md @@ -2,9 +2,9 @@ ## A. 3rd Party frameworks/libs -1. Download and install CodeIgniter-3.0.0. +1. Download and install CodeIgniter-3.1.11 (phar is preferred). 2. Download 3rd party libs/css used in application, - extract libs content it in `public/lib/` + extract libs content it in `public/lib/` accordingly. _For convenience the bundle can be found at `http://dev1.insteps.net/nbreader/lib.tar.gz`_ @@ -15,10 +15,10 @@ _For convenience the bundle can be found at `http://dev1.insteps.net/nbreader/li 2. Change install variables in `public/index.php` as needed. 3. Change install variables in - `public/application/config/config.php` as needed. + `apps/web/config/config.php` as needed. 4. Change install variables in - `public/application/config/newsbeuter.php` as needed. + `apps/web/config/newsbeuter.php` as needed. 5. Make sure feeds web url is properly installed and set. @@ -26,29 +26,18 @@ _For convenience the bundle can be found at `http://dev1.insteps.net/nbreader/li ## C. Create rss/atom list file -1. Add rss/atom feeds url in 'urls list file'. +1. Add rss/atom feeds url in 'config/url/.. list file'. See `config/readme.notes` -2. For every url list file in `config/url.local` - there needs to be a corresponding database file - in `var/newsbeuter/db`. - - If you have not run `update`, you can test/dummy run by - copying `config/empty.loc.db` to `var/newsbeuter/db`. - - eg. for list file `config/url/news` the database file - name would be `var/newsbeuter/db/news.loc.db` - - OR - - Let `sh run.sh config` create sample data for your during - initial setup ( when `config/url` folder contains no files ). +2. Run `sh run.sh config` to create sample data for + initial setup ( when `config/url/` folder contains no files ). There is no need to have multiple urls list file, if you want to keep things simple and store all data into single file/database. -3. If so far things seem ok, run `sh run.sh config` +3. If so far things seem ok, edit/add urls in config/url/. + run `sh run.sh config` _Note: you need to run `sh run.sh config` every time you edit/update files in `config/url/`_ -- cgit v1.2.3