X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FDownload-and-Installation.md;h=e64d1a43e25b55c4d53e64579e625335eb02b2b4;hb=refs%2Fpull%2F1028%2Fhead;hp=be848c97e9ab44f8629b5ffbeb2ad69d82c67b31;hpb=3ec25cc00fb7abe29a4a3061d9974cf82f2888d1;p=github%2Fshaarli%2FShaarli.git 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: - by cloning the Git repository - using Docker: [see the documentation](docker/shaarli-images) ---- +-------------------------------------------------------------------------------- ## Latest release (recommended) + ### Download as an archive -Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page. -**Download our *shaarli-full* archive** to include dependencies. +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. The current latest released version is `v0.9.1` -Or in command lines: - ```bash $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip $ unzip shaarli-v0.9.1-full.zip $ mv Shaarli /path/to/shaarli/ ``` -In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. -Cloning using `git` or downloading Github branches as zip files requires additional steps (see below). - ### Using git +Cloning using `git` or downloading Github branches as zip files requires additional steps: + + * Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. + * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation. + ``` $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ $ git clone -b latest https://github.com/shaarli/Shaarli.git . $ composer install --no-dev --prefer-dist $ make translate +$ make htmldoc ``` +-------------------------------------------------------------------------------- + ## Stable version The stable version has been experienced by Shaarli users, and will receive security updates. + ### Download as an archive As a .zip archive: @@ -69,9 +73,9 @@ $ tar xvf stable.tar.gz $ mv Shaarli-stable /path/to/shaarli/ ``` -### Clone with Git +### Using git -[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git. +Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. ```bash $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ @@ -80,10 +84,15 @@ $ cd /path/to/shaarli/ $ composer install --no-dev --prefer-dist ``` + +-------------------------------------------------------------------------------- + ## Development version (mainline) _Use at your own risk!_ +Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. + To get the latest changes from the `master` branch: ```bash @@ -93,8 +102,11 @@ $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ $ cd /path/to/shaarli $ composer install --no-dev --prefer-dist $ make translate +$ make htmldoc ``` +------------------------------------------------------------------------------- + ## Finish Installation Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.