đź“ť Ajoute le Readme

This commit is contained in:
Shikiryu 2017-01-13 15:54:15 +01:00
parent b686967d05
commit 09ff185fc9
1 changed files with 31 additions and 0 deletions

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# À quoi ça sert
> Ce bookmarklet, une fois cliqué, envoie un email avec le titre et le lien de la page courante à l'adresse que vous lui indiquez préalablement.
> En résumé, c'est un pense-bête, il fait gagner du temps.
# Installation
## Pré-requis
* >= Apache 2
* >= PHP5.3
## Installation
Dans le dossier d'un VHost :
### Manuellement
1. Télécharger [la dernière version du projet](https://git.shikiryu.com/Shikiryu/bookmarklet.shikiryu.com/archive/master.zip)
2. DĂ©zipper
3. À l'intérieur du dossier dézippé, renommer config.dist.php → config.php
4. Éditer config.php avec les paramètres souhaités
5. Envoyer le projet dans le dossier de votre hébergement
### En ligne de commande
```
git clone https://git.shikiryu.com/Shikiryu/bookmarklet.shikiryu.com.git bookmarklet
cd bookmarklet
cp config.dist.php config.php
vi config.php
```
Entrer la config attendue