From 84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 09:15:53 +0200 Subject: Added documentation about testsuite Fix #2415 --- docs/en/developer/testsuite.rst | 10 ++++++++++ docs/en/user/installation.rst | 3 +++ 2 files changed, 13 insertions(+) create mode 100644 docs/en/developer/testsuite.rst (limited to 'docs/en') diff --git a/docs/en/developer/testsuite.rst b/docs/en/developer/testsuite.rst new file mode 100644 index 00000000..b2b16cdc --- /dev/null +++ b/docs/en/developer/testsuite.rst @@ -0,0 +1,10 @@ +Testsuite +========= + +To ensure wallabag development quality, we wrote tests with `PHPUnit `_. + +If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests. + +To launch wallabag testsuite, you need to install `ant `_. + +Then, execute this command ``make test``. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index a2f0d07b..0920b976 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -6,6 +6,9 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. +.. 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: -- cgit v1.2.3