From 43ad7c8e825057747ccf02049050b323878952a7 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Sat, 5 Aug 2017 11:56:24 +0200 Subject: documentation: fix rendering and internal references This is mainly cleanup after switching from Github-flavoured Markdown rendered by Github Pages, to standard Markdown rendered by MkDocs. Changed: - rephrase some section titles Fixed: - list rendering (items, sub-items)) - code rendering - quotes - dead links Removed: - extraneous navigational elements Signed-off-by: VirtualTam --- doc/md/Download-and-Installation.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) (limited to 'doc/md/Download-and-Installation.md') diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index 7880aef4..cdc503a8 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md @@ -1,8 +1,16 @@ -To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your [server](Server-requirements) is properly [configured](Server-configuration). +To install Shaarli, simply place the files in a directory under your webserver's +Document Root (or directly at the document root). + +Also, please make sure your server meets the [requirements](Server-requirements) +and is properly [configured](Server-configuration). Several releases are available: --------------------------------------------------------- +- by downloading full release archives including all dependencies +- by downloading Github archives +- by cloning the Git repository + +--- ## Latest release (recommended) ### Download as an archive @@ -20,19 +28,16 @@ $ unzip shaarli-v0.8.4-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).| -|-----|--------------------------| +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 ``` -mkdir -p /path/to/shaarli && cd /path/to/shaarli/ -git clone -b v0.8 https://github.com/shaarli/Shaarli.git . -composer install --no-dev +$ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ +$ git clone -b v0.8 https://github.com/shaarli/Shaarli.git . +$ composer install --no-dev --prefer-dist ``` --------------------------------------------------------- - ## Stable version The stable version has been experienced by Shaarli users, and will receive security updates. @@ -63,11 +68,9 @@ $ mv Shaarli-stable /path/to/shaarli/ $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ # install/update third-party dependencies $ cd /path/to/shaarli/ -$ composer install --no-dev +$ composer install --no-dev --prefer-dist ``` --------------------------------------------------------- - ## Development version (mainline) _Use at your own risk!_ @@ -79,11 +82,9 @@ To get the latest changes from the `master` branch: $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ # install/update third-party dependencies $ cd /path/to/shaarli -$ composer install --no-dev +$ composer install --no-dev --prefer-dist ``` --------------------------------------------------------- - ## Finish Installation Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. @@ -92,8 +93,6 @@ Once Shaarli is downloaded and files have been placed at the correct location, o Setup your Shaarli installation, and it's ready to use! --------------------------------------------------------- - ## Updating Shaarli See [Upgrade and Migration](Upgrade-and-migration) -- cgit v1.2.3