aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Download-and-Installation.md
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2018-03-28 19:08:06 +0200
committerGitHub <noreply@github.com>2018-03-28 19:08:06 +0200
commitc81f1afc0a3a16daf98741a63c7524b27835da99 (patch)
treedfe81b73f028dfc27eda916b14bf4bc17966b082 /doc/md/Download-and-Installation.md
parent9b2bd66fb60ffd5a833480bf329062c7d57bc8c4 (diff)
parentd7eb06bd7c4d01bbdf67f4f100af7a3e300098d3 (diff)
downloadShaarli-c81f1afc0a3a16daf98741a63c7524b27835da99.tar.gz
Shaarli-c81f1afc0a3a16daf98741a63c7524b27835da99.tar.zst
Shaarli-c81f1afc0a3a16daf98741a63c7524b27835da99.zip
Merge pull request #1072 from ArthurHoaro/feature/modern-front-end
Manage frontend dependencies with npm/yarn and webpack
Diffstat (limited to 'doc/md/Download-and-Installation.md')
-rw-r--r--doc/md/Download-and-Installation.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md
index 05f0c8f2..20138f49 100644
--- a/doc/md/Download-and-Installation.md
+++ b/doc/md/Download-and-Installation.md
@@ -38,12 +38,14 @@ $ mv Shaarli /path/to/shaarli/
38Cloning using `git` or downloading Github branches as zip files requires additional steps: 38Cloning using `git` or downloading Github branches as zip files requires additional steps:
39 39
40 * Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. 40 * Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies.
41 * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend dependencies.
41 * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation. 42 * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation.
42 43
43``` 44```
44$ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ 45$ mkdir -p /path/to/shaarli && cd /path/to/shaarli/
45$ git clone -b latest https://github.com/shaarli/Shaarli.git . 46$ git clone -b latest https://github.com/shaarli/Shaarli.git .
46$ composer install --no-dev --prefer-dist 47$ composer install --no-dev --prefer-dist
48$ make build_frontend
47$ make translate 49$ make translate
48$ make htmldoc 50$ make htmldoc
49``` 51```
@@ -91,7 +93,9 @@ $ composer install --no-dev --prefer-dist
91 93
92_Use at your own risk!_ 94_Use at your own risk!_
93 95
94Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. 96Install [Composer](Unit-tests.md#install_composer) to manage Shaarli PHP dependencies,
97and [yarn](https://yarnpkg.com/lang/en/docs/install/)
98for front-end dependencies.
95 99
96To get the latest changes from the `master` branch: 100To get the latest changes from the `master` branch:
97 101
@@ -101,6 +105,7 @@ $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
101# install/update third-party dependencies 105# install/update third-party dependencies
102$ cd /path/to/shaarli 106$ cd /path/to/shaarli
103$ composer install --no-dev --prefer-dist 107$ composer install --no-dev --prefer-dist
108$ make build_frontend
104$ make translate 109$ make translate
105$ make htmldoc 110$ make htmldoc
106``` 111```