aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorV.Krishn <vkrishn4@gmail.com>2015-08-12 18:09:38 +0530
committerV.Krishn <vkrishn4@gmail.com>2015-08-12 18:09:38 +0530
commitaa75cb3158898ea253360d3113e5a1d962300b5b (patch)
tree16cc654263841d90368cf92108f85ab67a4c87a0 /doc
parent56c124ce5cb7511a5785cd3aa88f2ee0888f4665 (diff)
downloadnbreader-aa75cb3158898ea253360d3113e5a1d962300b5b.tar.bz2
improve install docs
Diffstat (limited to 'doc')
-rw-r--r--doc/install.md51
1 files changed, 32 insertions, 19 deletions
diff --git a/doc/install.md b/doc/install.md
index 213ffc6..1b2a6d2 100644
--- a/doc/install.md
+++ b/doc/install.md
@@ -1,6 +1,30 @@
-## A. Create rss/atom list file
+## A. 3rd Party frameworks/libs
+
+1. Download and install CodeIgniter-3.0.0.
+2. Download 3rd party libs/css used in application,
+ extract libs content it in public/lib/<other web libs>
+
+_For convenience the bundle can be found at `http://dev1.insteps.net/nbreader/lib.tar.gz`_
+
+## B. Configs
+
+1. Change install variables in `scripts/env.sh` as needed.
+
+2. Change install variables in `public/index.php` as needed.
+
+3. Change install variables in
+ `public/application/config/config.php` as needed.
+
+4. Change install variables in
+ `public/application/config/newsbeuter.php` as needed.
+
+5. Make sure feeds web url is properly installed and set.
+
+6. Make sure php or codeiginter's session path is set.
+
+## C. Create rss/atom list file
1. Add rss/atom feeds url in 'urls list file'.
See `config/readme.notes`
@@ -8,34 +32,23 @@
there needs to be a corresponding database file
in `var/newsbeuter/db`.
- If you have not run `update`, you can test run by
+ 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 ).
+
There is no need to have multiple urls list file,
if you want to keep things simple and store all
data into single file.
-## B. 3rd Party frameworks/libs
-
-1. Download and install CodeIgniter-3.0.0.
-2. Download 3rd party libs/css used in application,
- extract libs content it in public/lib/<other web libs>
-
-_For convenience the bundle can be found at `http://dev1.insteps.net/nbreader/lib.tar.gz`_
-
-## C. Configs
-
-1. Change install variables in `scripts/env.sh` as needed.
-
-2. Change install variables in `public/index.php` as needed.
-
-3. Change install variables in
- `public/application/config/newsbeuter.php` as needed.
-4. Run `sh run.sh config`
+3. If so far things seem ok, run `sh run.sh config`
## D. Fix Directory Permissions