1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2025-08-01 17:38:38 +00:00

Add documentation about article sharing

This commit is contained in:
Nicolas Lœuillet 2016-08-25 15:28:46 +02:00
parent 05d2d62f12
commit 8fed8d1bac
10 changed files with 64 additions and 17 deletions

View file

@ -40,6 +40,7 @@ The documentation is available in other languages:
user/errors_during_fetching
user/annotations
user/download_articles
user/share
user/filters
user/tags
user/android

View file

@ -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 <https://getcomposer.org/doc/00-intro.md>`__:
You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
You also need to install node.js (via `the Download page <https://nodejs.org/en/download/>`__), 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:

17
docs/en/user/share.rst Normal file
View file

@ -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