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 | |
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)
-rw-r--r-- | Makefile | 11 | ||||
-rw-r--r-- | doc/md/Download-and-Installation.md | 32 | ||||
-rw-r--r-- | doc/md/Unit-tests.md | 10 |
3 files changed, 28 insertions, 25 deletions
@@ -1,17 +1,6 @@ | |||
1 | # The personal, minimalist, super-fast, database free, bookmarking service. | 1 | # The personal, minimalist, super-fast, database free, bookmarking service. |
2 | # Makefile for PHP code analysis & testing, documentation and release generation | 2 | # Makefile for PHP code analysis & testing, documentation and release generation |
3 | 3 | ||
4 | # Prerequisites: | ||
5 | # - install Composer, either: | ||
6 | # - from your distro's package manager; | ||
7 | # - from the official website (https://getcomposer.org/download/); | ||
8 | # - install/update test dependencies: | ||
9 | # $ composer install # 1st setup | ||
10 | # $ composer update | ||
11 | # - install Xdebug for PHPUnit code coverage reports: | ||
12 | # - see http://xdebug.org/docs/install | ||
13 | # - enable in php.ini | ||
14 | |||
15 | BIN = vendor/bin | 4 | BIN = vendor/bin |
16 | PHP_SOURCE = index.php application tests plugins | 5 | PHP_SOURCE = index.php application tests plugins |
17 | PHP_COMMA_SOURCE = index.php,application,tests,plugins | 6 | PHP_COMMA_SOURCE = index.php,application,tests,plugins |
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index be848c97..e64d1a43 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md | |||
@@ -17,40 +17,44 @@ Using one of the following methods: | |||
17 | - by cloning the Git repository | 17 | - by cloning the Git repository |
18 | - using Docker: [see the documentation](docker/shaarli-images) | 18 | - using Docker: [see the documentation](docker/shaarli-images) |
19 | 19 | ||
20 | --- | 20 | -------------------------------------------------------------------------------- |
21 | 21 | ||
22 | ## Latest release (recommended) | 22 | ## Latest release (recommended) |
23 | |||
23 | ### Download as an archive | 24 | ### Download as an archive |
24 | Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page. | ||
25 | 25 | ||
26 | **Download our *shaarli-full* archive** to include dependencies. | 26 | In most cases, you should download the latest Shaarli release from the [releases](https://github.com/shaarli/Shaarli/releases) page. **Download our *shaarli-full* archive** to include dependencies. |
27 | 27 | ||
28 | The current latest released version is `v0.9.1` | 28 | The current latest released version is `v0.9.1` |
29 | 29 | ||
30 | Or in command lines: | ||
31 | |||
32 | ```bash | 30 | ```bash |
33 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip | 31 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip |
34 | $ unzip shaarli-v0.9.1-full.zip | 32 | $ unzip shaarli-v0.9.1-full.zip |
35 | $ mv Shaarli /path/to/shaarli/ | 33 | $ mv Shaarli /path/to/shaarli/ |
36 | ``` | 34 | ``` |
37 | 35 | ||
38 | In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. | ||
39 | Cloning using `git` or downloading Github branches as zip files requires additional steps (see below). | ||
40 | |||
41 | ### Using git | 36 | ### Using git |
42 | 37 | ||
38 | Cloning using `git` or downloading Github branches as zip files requires additional steps: | ||
39 | |||
40 | * Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. | ||
41 | * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation. | ||
42 | |||
43 | ``` | 43 | ``` |
44 | $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ | 44 | $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ |
45 | $ git clone -b latest https://github.com/shaarli/Shaarli.git . | 45 | $ git clone -b latest https://github.com/shaarli/Shaarli.git . |
46 | $ composer install --no-dev --prefer-dist | 46 | $ composer install --no-dev --prefer-dist |
47 | $ make translate | 47 | $ make translate |
48 | $ make htmldoc | ||
48 | ``` | 49 | ``` |
49 | 50 | ||
51 | -------------------------------------------------------------------------------- | ||
52 | |||
50 | ## Stable version | 53 | ## Stable version |
51 | 54 | ||
52 | The stable version has been experienced by Shaarli users, and will receive security updates. | 55 | The stable version has been experienced by Shaarli users, and will receive security updates. |
53 | 56 | ||
57 | |||
54 | ### Download as an archive | 58 | ### Download as an archive |
55 | 59 | ||
56 | As a .zip archive: | 60 | As a .zip archive: |
@@ -69,9 +73,9 @@ $ tar xvf stable.tar.gz | |||
69 | $ mv Shaarli-stable /path/to/shaarli/ | 73 | $ mv Shaarli-stable /path/to/shaarli/ |
70 | ``` | 74 | ``` |
71 | 75 | ||
72 | ### Clone with Git | 76 | ### Using git |
73 | 77 | ||
74 | [Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git. | 78 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. |
75 | 79 | ||
76 | ```bash | 80 | ```bash |
77 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ | 81 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ |
@@ -80,10 +84,15 @@ $ cd /path/to/shaarli/ | |||
80 | $ composer install --no-dev --prefer-dist | 84 | $ composer install --no-dev --prefer-dist |
81 | ``` | 85 | ``` |
82 | 86 | ||
87 | |||
88 | -------------------------------------------------------------------------------- | ||
89 | |||
83 | ## Development version (mainline) | 90 | ## Development version (mainline) |
84 | 91 | ||
85 | _Use at your own risk!_ | 92 | _Use at your own risk!_ |
86 | 93 | ||
94 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. | ||
95 | |||
87 | To get the latest changes from the `master` branch: | 96 | To get the latest changes from the `master` branch: |
88 | 97 | ||
89 | ```bash | 98 | ```bash |
@@ -93,8 +102,11 @@ $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ | |||
93 | $ cd /path/to/shaarli | 102 | $ cd /path/to/shaarli |
94 | $ composer install --no-dev --prefer-dist | 103 | $ composer install --no-dev --prefer-dist |
95 | $ make translate | 104 | $ make translate |
105 | $ make htmldoc | ||
96 | ``` | 106 | ``` |
97 | 107 | ||
108 | ------------------------------------------------------------------------------- | ||
109 | |||
98 | ## Finish Installation | 110 | ## Finish Installation |
99 | 111 | ||
100 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. | 112 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. |
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 |