diff options
author | nodiscc <nodiscc@gmail.com> | 2017-11-18 16:22:43 +0100 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2017-11-18 16:22:43 +0100 |
commit | 76c3a4dbed11b9a5df2437db00e96608244bd693 (patch) | |
tree | 626e3ff5d20ece1430e9c96ec42b1d3b6a630a3a /doc/md/Unit-tests.md | |
parent | 3ec25cc00fb7abe29a4a3061d9974cf82f2888d1 (diff) | |
download | Shaarli-76c3a4dbed11b9a5df2437db00e96608244bd693.tar.gz Shaarli-76c3a4dbed11b9a5df2437db00e96608244bd693.tar.zst Shaarli-76c3a4dbed11b9a5df2437db00e96608244bd693.zip |
documentation cleanup
* In preparation of #930 work
* Remove/reorder duplicate documentation from Makefile/Unit-tests.md/Download-and-Installation.md (composer information is now in Unit-tests.md)
* Installation using git: add composer requirement to all git installation procedures, add python3-virtualenv requirement
* Styling (horizontal rulers, spacing, descriptive headers)
Diffstat (limited to 'doc/md/Unit-tests.md')
-rw-r--r-- | doc/md/Unit-tests.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/md/Unit-tests.md b/doc/md/Unit-tests.md index d200634f..f6030d5c 100644 --- a/doc/md/Unit-tests.md +++ b/doc/md/Unit-tests.md | |||
@@ -2,12 +2,12 @@ | |||
2 | 2 | ||
3 | The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. | 3 | The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. |
4 | 4 | ||
5 | Regarding Composer, you can either use: | 5 | ### Install composer |
6 | 6 | ||
7 | - a system-wide version, e.g. installed through your distro's package manager | 7 | You can either use: |
8 | - a local version, downloadable [here](https://getcomposer.org/download/) | ||
9 | 8 | ||
10 | #### Sample usage | 9 | - a system-wide version, e.g. installed through your distro's package manager |
10 | - a local version, downloadable [here](https://getcomposer.org/download/). | ||
11 | 11 | ||
12 | ```bash | 12 | ```bash |
13 | # system-wide version | 13 | # system-wide version |
@@ -29,6 +29,8 @@ $ composer update | |||
29 | 29 | ||
30 | #### Install and enable Xdebug to generate PHPUnit coverage reports | 30 | #### Install and enable Xdebug to generate PHPUnit coverage reports |
31 | 31 | ||
32 | See http://xdebug.org/docs/install | ||
33 | |||
32 | For Debian-based distros: | 34 | For Debian-based distros: |
33 | ```bash | 35 | ```bash |
34 | $ aptitude install php5-xdebug | 36 | $ aptitude install php5-xdebug |