aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-08-25 15:28:46 +0200
committerNicolas LÅ“uillet <nicolas@loeuillet.org>2016-09-19 15:20:46 +0200
commit8fed8d1bacbbcbf606a94497c5b58f49068bd6a3 (patch)
tree8e56b1503d1781899c6fb1c160f05993108366be /docs/en/user
parent05d2d62f128df5dafa3be17d9848fb9b5b146836 (diff)
downloadwallabag-8fed8d1bacbbcbf606a94497c5b58f49068bd6a3.tar.gz
wallabag-8fed8d1bacbbcbf606a94497c5b58f49068bd6a3.tar.zst
wallabag-8fed8d1bacbbcbf606a94497c5b58f49068bd6a3.zip
Add documentation about article sharing
Diffstat (limited to 'docs/en/user')
-rw-r--r--docs/en/user/installation.rst16
-rw-r--r--docs/en/user/share.rst17
2 files changed, 28 insertions, 5 deletions
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
37On a dedicated web server (recommended way) 37On a dedicated web server (recommended way)
38~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 38~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39 39
40wallabag 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``). 40wallabag 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``).
41 41
42Install Composer: 42Install Composer:
43 43
@@ -45,7 +45,14 @@ Install Composer:
45 45
46 curl -s http://getcomposer.org/installer | php 46 curl -s http://getcomposer.org/installer | php
47 47
48You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__: 48You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
49
50You also need to install node.js (via `the Download page <https://nodejs.org/en/download/>`__), npm (already install with node.js), bower and grunt:
51
52::
53
54 npm install -g bower
55 npm install -g grunt-cli
49 56
50To install wallabag itself, you must run the following commands: 57To install wallabag itself, you must run the following commands:
51 58
@@ -53,9 +60,8 @@ To install wallabag itself, you must run the following commands:
53 60
54 git clone https://github.com/wallabag/wallabag.git 61 git clone https://github.com/wallabag/wallabag.git
55 cd wallabag 62 cd wallabag
56 git checkout 2.0.8 63 git checkout 2.1
57 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist 64 ./install.sh
58 php bin/console wallabag:install --env=prod
59 65
60To start PHP's build-in server and test if everything did install correctly, you can do: 66To start PHP's build-in server and test if everything did install correctly, you can do:
61 67
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 @@
1Share articles
2==============
3
4When you're reading an article, you can share it. Just click on the share button:
5
6.. image:: ../../img/user/share.png
7 :alt: share article
8 :align: center
9
10Now, you can share the article:
11
12- with a public URL (you'll have a light view of the article)
13- with a tweet
14- into your Shaarli
15- with a post in Diaspora*
16- to Carrot
17- with an email