Revert "Add SHAARLI support to view template"

[github/wallabag/wallabag.git] / INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
index 74627f3b4a9c10987c7d32232699c7e480bf4dc9..63000f264b0c6ce80f4e6358244c1d70d7f62529 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,55 +1,64 @@
 # Installing poche
 
-Get the [latest twig version](https://github.com/inthepoche/poche/archive/twig.zip) of poche on github. Unzip it and upload it on your server.
+## requirements
 
-your datas can be stored on sqlite, postgres or mysql databases.
+it's highly recommended to have php cURL and tidy_parse_string to fetch articles content. 
 
-Edit /inc/poche/config.inc.php :
+## you don't want to install twig (the template engine) by yourself
 
-```php
-define ('STORAGE','sqlite'); # postgres, mysql, sqlite
-define ('STORAGE_SERVER', 'localhost'); # leave blank for sqlite
-define ('STORAGE_DB', 'poche'); # only for postgres & mysql
-define ('STORAGE_SQLITE', './db/poche.sqlite');
-define ('STORAGE_USER', 'user'); # leave blank for sqlite
-define ('STORAGE_PASSWORD', 'pass'); # leave blank for sqlite
-```
+Download this file http://static.inthepoche.com/files/poche-1.0-latest-with-twig.zip
+
+Extract this file on your server.
 
-poche must have write access on assets, cache and db directories.
+## you want to install twig by yourself 
 
-[PHP cURL](http://www.php.net/manual/en/book.curl.php) & [tidy_parse_string](http://www.php.net/manual/en/tidy.parsestring.php) are recommended.
+Download the latest version here : http://www.inthepoche.com/?pages/T%C3%A9l%C3%A9charger-poche
 
-## twig
-poche now uses twig for templating. You have to install twig. 
+Extract this file on your server.
 
-Install composer in your project : 
-```bash
+```php
 curl -s http://getcomposer.org/installer | php
-```
-Install via composer : 
-```bash
 php composer.phar install
 ```
 
-If you don't want to install twig by yourself, you can download [this file](http://static.inthepoche.com/files/poche-1.0-latest-with-twig.zip).
+### using sqlite
+
+Copy / paste install/poche.sqlite in db folder.
+
+### using mysql or postgresql
+
+Execute the sql file in /install (mysql.sql or postgres.sql)
+
+Then, go to step 3.
+
+# Upgrading poche
+
+Replace all the files except **db/poche.sqlite**. Also remember to edit the file /inc/poche/config.inc.php.
+
+## Upgrading from poche <= 0.3
+
+You have to execute http://yourpoche/install/update_sqlite_from_0_to_1.php
+
+Then, go to step 3.
+
+## Upgrading from poche >= 1.0 beta1
+
+Nothing to do here. 
+
+Then, go to step 3.
 
-## storage in sqlite 
-You have to install [sqlite for php](http://www.php.net/manual/en/book.sqlite.php) on your server.
+# Here is the step 3
 
-Copy /install/poche.sqlite in /db
+You must have write access on assets, cache and db directories. These directories may not exist, you'll have to create them.
 
-## storage in mysql
-Execute /install/mysql.sql file in your database.
+You can use poche ! Enjoy.
 
-## storage in postgres 
-Execute /install/postgres.sql file in your database.
+# Some problems you may encounter
 
-## upgrading from poche <= 0.3
-With poche <= 0.3, all your datas were stored in a sqlite file. The structure of this file changed. 
+## Blank page
 
-You have to execute http://yourpoche/install/update_sqlite_from_0_to_1.php before using this new version.
+Be sure to have write access on assets, cache and db directories.
 
-That's all, you can use poche ! 
+## PHP Fatal error:  Call to a member function fetchAll() on a non-object in /var/www/poche/inc/poche/Database.class.php on line 42
 
-## installing poche
-you can go on your poche http://yourpoche. You have to fill the fields and that's all !
\ No newline at end of file
+If you want to install poche, delete the db/poche.sqlite file and copy / paste the install/poche.sqlite in /db. Be sure to have write access.
\ No newline at end of file