Update documentation

diff --git a/Makefile b/Makefile
index e99367f67222f1b6f58dc97884ee1e044664cf93..1c6c0d5373eceb362e0abbe6f7044b9c183dfd2c 100755 (executable)
--- a/Makefile
+++ b/Makefile
@@ -24,6 +24,7 @@ build: ## Run grunt
        @grunt
 
 test: ## Launch wallabag testsuite
+       @if [ ! -d "vendor/phpunit" ]; then composer install; fi
        @ant prepare && vendor/phpunit/phpunit/phpunit -v
 
 release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`).

diff --git a/README.md b/README.md
index 8de3279def1a161ce11a1f21992030d21d5e3022..c948828843bc043589ba6217dcb6f437ee8c470b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,9 +17,8 @@ Then you can install wallabag by executing the following commands:
 
 ```
 git clone https://github.com/wallabag/wallabag.git
-cd wallabag
-./install.sh
-php bin/console server:run --env=prod
+cd wallabag && make install
+make run
 ```
 
 # License

diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
index 627bd844caf619e6dbdf5e86d1b61df7b66b228f..767f5e2601e003bfc773322f041af096f59597bd 100644 (file)
--- a/RELEASE_PROCESS.md
+++ b/RELEASE_PROCESS.md
@@ -15,23 +15,22 @@ During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`.
 
 - Run these commands to create the tag:
 
- ```
- git checkout master
- git pull origin master
- git checkout -b release-$LAST_WALLABAG_RELEASE
- SYMFONY_ENV=prod composer up --no-dev
- git add --force composer.lock
- git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
- git push origin release-$LAST_WALLABAG_RELEASE
- ```
+```
+git checkout master
+git pull origin master
+git checkout -b release-$LAST_WALLABAG_RELEASE
+SYMFONY_ENV=prod composer up --no-dev
+git add --force composer.lock
+git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
+git push origin release-$LAST_WALLABAG_RELEASE
+```
 
 - Create a new pull request with this title `DON'T MERGE Release wallabag $LAST_WALLABAG_RELEASE`. This pull request is used to launch builds on Travis-CI.
-- Run these commands to create the package (you need to clone `https://github.com/wallabag/releaser`) :
+- Run these command to create the package:
 
- ```
- cd releaser/
- ./releaser.sh $LAST_WALLABAG_RELEASE
- ```
+```
+make releas emaster /tmp wllbg-release prod
+```
 
 - [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
 - Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**).

diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst
index bee3249b025945e9db69fdfce103b055547f79b2..2bb86269ba608c55317fc85f982a444d31273fa4 100644 (file)
--- a/docs/de/user/installation.rst
+++ b/docs/de/user/installation.rst
@@ -57,14 +57,13 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
 ::
 
     git clone https://github.com/wallabag/wallabag.git
-    cd wallabag
-    ./install.sh
+    cd wallabag && make install
 
 Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen:
 
 ::
 
-    php bin/console server:run --env=prod
+    make run
 
 und wallabag unter http://deineserverip:8000 erreichen.
 

diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 0920b976738bb7a8c0bc535793eb2559f44625b3..e08e0306fa0a039eadfe7a0f99017809d0ee6646 100644 (file)
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -56,14 +56,13 @@ To install wallabag itself, you must run the following commands:
 ::
 
     git clone https://github.com/wallabag/wallabag.git
-    cd wallabag
-    ./install.sh
+    cd wallabag && make install
 
 To start PHP's build-in server and test if everything did install correctly, you can do:
 
 ::
 
-    php bin/console server:run --env=prod
+    make run
 
 And access wallabag at http://yourserverip:8000
 
@@ -240,12 +239,12 @@ Rights access to the folders of the project
 Test environment
 ~~~~~~~~~~~~~~~~
 
-When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem.
+When we just want to test wallabag, we just run the command ``make run`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem.
 
 Production environment
 ~~~~~~~~~~~~~~~~~~~~~~
 
-As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command  ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project.
+As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command  ``make run`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project.
 
 To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used).
 

diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index 55614d729429cdacba45e52bf5eac54e882cc1fa..b32707f8daf8e169b1fc410dce45ac6e3d7e2303 100644 (file)
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -54,14 +54,13 @@ Pour installer wallabag, vous devez exécuter ces commandes :
 ::
 
     git clone https://github.com/wallabag/wallabag.git
-    cd wallabag
-    ./install.sh
+    cd wallabag && make install
 
 Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
 
 ::
 
-    php bin/console server:run --env=prod
+    make run
 
 Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
 

diff --git a/scripts/install.sh b/scripts/install.sh
index 755aac1c738fa5f82c1e7520931ffaa57c1fda9a..54d0bb785b62976109f5b3e98c5da7c8e92e200d 100644 (file)
--- a/scripts/install.sh
+++ b/scripts/install.sh
@@ -1,4 +1,6 @@
 #! /usr/bin/env bash
+# You can execute this file to install wallabag
+# eg: `sh install.sh prod`
 
 ENV=$1
 TAG=$(git describe --tags $(git rev-list --tags --max-count=1))

diff --git a/scripts/release.sh b/scripts/release.sh
index 3d096430487d0ae12cd4851bbbd4bda6cd6d9de4..e118b87edd106d41be2a0cbd3916fd8b701730a4 100644 (file)
--- a/scripts/release.sh
+++ b/scripts/release.sh
@@ -1,4 +1,6 @@
 #! /usr/bin/env bash
+# You can execute this file to create a new package for wallabag
+# eg: `sh release.sh master /tmp wllbg-release prod`
 
 VERSION=$1
 TMP_FOLDER=$2

diff --git a/scripts/update.sh b/scripts/update.sh
index 48281210d02e241c441994830f299bb12e2f4124..b920a829b0ae06558f22d6865a7b226390fcab14 100644 (file)
--- a/scripts/update.sh
+++ b/scripts/update.sh
@@ -1,4 +1,6 @@
 #! /usr/bin/env bash
+# You can execute this file to update wallabag
+# eg: `sh update.sh prod`
 
 ENV=$1
 TAG=$(git describe --tags $(git rev-list --tags --max-count=1))