From 8fed8d1bacbbcbf606a94497c5b58f49068bd6a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 25 Aug 2016 15:28:46 +0200 Subject: Add documentation about article sharing --- docs/en/user/installation.rst | 16 +++++++++++----- docs/en/user/share.rst | 17 +++++++++++++++++ 2 files changed, 28 insertions(+), 5 deletions(-) create mode 100644 docs/en/user/share.rst (limited to 'docs/en/user') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 763d7c66..3794c757 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -37,7 +37,7 @@ Installation On a dedicated web server (recommended way) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -wallabag uses a large number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). +wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). Install Composer: @@ -45,7 +45,14 @@ Install Composer: curl -s http://getcomposer.org/installer | php -You can find specific instructions `here `__: +You can find specific instructions `here `__. + +You also need to install node.js (via `the Download page `__), npm (already install with node.js), bower and grunt: + +:: + + npm install -g bower + npm install -g grunt-cli To install wallabag itself, you must run the following commands: @@ -53,9 +60,8 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + git checkout 2.1 + ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: diff --git a/docs/en/user/share.rst b/docs/en/user/share.rst new file mode 100644 index 00000000..e99e51ab --- /dev/null +++ b/docs/en/user/share.rst @@ -0,0 +1,17 @@ +Share articles +============== + +When you're reading an article, you can share it. Just click on the share button: + +.. image:: ../../img/user/share.png + :alt: share article + :align: center + +Now, you can share the article: + +- with a public URL (you'll have a light view of the article) +- with a tweet +- into your Shaarli +- with a post in Diaspora* +- to Carrot +- with an email -- cgit v1.2.3