Added documentation about testsuite

[github/wallabag/wallabag.git] / docs / en / user / installation.rst

diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 3794c75763cf8e8a5e8fd06301a7fe6453255d1a..0920b976738bb7a8c0bc535793eb2559f44625b3 100644 (file)
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -6,7 +6,20 @@ Requirements
 
 wallabag is compatible with PHP >= 5.5, including PHP 7.
 
 
 wallabag is compatible with PHP >= 5.5, including PHP 7.
 

-You'll need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages.
+.. note::
+To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
+
+wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
+
+Install Composer:
+
+::
+
+    curl -s http://getcomposer.org/installer | php
+
+You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
+
+You'll also need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages.

 
 - php-session
 - php-ctype
 
 - php-session
 - php-ctype


@@ -22,6 +35,7 @@ You'll need the following extensions for wallabag to work. Some of these may alr
 - php-curl
 - php-gettext
 - php-tokenizer
 - php-curl
 - php-gettext
 - php-tokenizer

+- php-bcmath

 
 wallabag uses PDO to connect to the database, so you'll need one of the following:
 
 
 wallabag uses PDO to connect to the database, so you'll need one of the following:
 


@@ -37,30 +51,12 @@ Installation
 On a dedicated web server (recommended way)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 On a dedicated web server (recommended way)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

-wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
-
-Install Composer:
-
-::
-
-    curl -s http://getcomposer.org/installer | php
-
-You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
-
-You also need to install node.js (via `the Download page <https://nodejs.org/en/download/>`__), npm (already install with node.js), bower and grunt:
-
-::
-
-    npm install -g bower
-    npm install -g grunt-cli
-

 To install wallabag itself, you must run the following commands:
 
 ::
 
     git clone https://github.com/wallabag/wallabag.git
     cd wallabag
 To install wallabag itself, you must run the following commands:
 
 ::
 
     git clone https://github.com/wallabag/wallabag.git
     cd wallabag

-    git checkout 2.1

     ./install.sh
 
 To start PHP's build-in server and test if everything did install correctly, you can do:
     ./install.sh
 
 To start PHP's build-in server and test if everything did install correctly, you can do:


@@ -91,18 +87,18 @@ Execute this command to download and extract the latest package:
 
     wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
 
 
     wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
 

-(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``)
+You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.

 
 Now, read the following documentation to create your virtual host, then access your wallabag.
 If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``.
 
 Installation with Docker
 
 Now, read the following documentation to create your virtual host, then access your wallabag.
 If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``.
 
 Installation with Docker

-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~

 
 We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
 
 Command to launch container
 
 We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
 
 Command to launch container

-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^

 
 .. code-block:: bash
 
 
 .. code-block:: bash