Merge branch 'Readme_upgrade' into 'master'

Readme upgrade

See merge request Tigriz/matrix-stickers!8

README.md

 # Matrix Stickers
-Dépôt regroupant les différents pack de stickers créés par les IIEns et les informations relatives aux stickers custom.
+Matrix-stickers est un dépôt créé pour regrouper les pack de stickers créés par les IIEns.
+Il propose aussi plusieurs tutoriels afin d'installer un meilleur "stickerpicker", d'utiliser des packs de sticker 
+ainsi que de les créer soi-même.  
+Salon d'aide : ##sticker:iiens.net
 
-## Utiliser les stickers d'un ami
-Si vous avez des amis ayant déjà leur propre sticker picker, il est possible de le réutiliser.
+**Table des matières**  
+- [Utiliser le stickerpicker d'un ami](#user-content-utiliser-le-stickerpicker-dun-ami)  
+- [Avoir un meilleur stickerpicker](#user-content-avoir-un-meilleur-stickerpicker)  
+- [Utiliser un pack de sticker du dépôt](#user-content-utiliser-un-pack-de-sticker)
+- [Créer des packs de stickers](#user-content-créer-des-packs-de-stickers)   
+
+## Utiliser le stickerpicker d'un ami
+Si vous avez des amis ayant déjà leur propre stickerpicker, il est possible de le réutiliser.
 Pour cela :
 1. Demandez lui l'autorisation (ou non)
 2. Récupérez l'adresse sur laquelle il héberge ses stickers. Cette adresse est de la forme :
@@ -10,7 +19,8 @@ Pour cela :
   https://nom.iiens.net/stickerpicker/web/?theme=$theme
   ```  
 3. Connectez vous à Element. Utilisez la commande `/devtools`
-4. Cliquer sur `Explorer les données du compte` puis sur `m.widgets` (si absent, le créer)
+4. Cliquer sur `Explorer les données du compte` puis sur `m.widgets`. Si absent, activer le gestionnaire d'intégration.
+   `Tout les paramètres -> général -> Gérer les intégrations`. Puis envoyer n'importe quel sticker.
 5. Cliquer sur `Modifier` et remplacer tout par le code suivant en n'oubliant pas de modifier
    les champs "url" et "sender": 
 ```json
@@ -18,8 +28,7 @@ Pour cela :
     "stickerpicker": {
         "content": {
             "type": "m.stickerpicker",
-            "url": "https://example.com/stickerpicker/web/?theme=$theme", // TODO à remplacer par l'adresse
-            // nom.iiens.net sur Arise
+            "url": "https://example.com/stickerpicker/web/?theme=$theme", // TODO à remplacer par l'adresse du pote
             "name": "Stickerpicker",
             "data": {}
         },
@@ -34,7 +43,10 @@ Pour cela :
    Supprimer ensuite les commentaires  
 6. Actualiser
 
-## Avoir un meilleur sticker picker et des stickers perso
+## Avoir un meilleur stickerpicker
+Le stickerpicker de base ne permet pas d'utiliser des stickers personnalisés.
+Il faut donc installer notre propre stickerpicker qui pourra les utiliser.
+Pour cela:
 1. Se connecter à son perso ou son site web 
   ```bash
   ssh nomArise@perso.iiens.net
@@ -50,7 +62,9 @@ Pour cela :
   ```
 4. Se connecter à Element. Utiliser la commande `/devtools` dans n'importe quel tchat.  
    ![devtools](screenshots/screen_devtools.png)
-5. Cliquer sur `Explorer les données du compte` puis sur `m.widgets` (si absent, le créer)  
+5. Cliquer sur `Explorer les données du compte` puis sur `m.widgets`. 
+   - Si absent, activer le gestionnaire d'intégration :
+   `Tout les paramètres -> Général -> Gerer les intégrations`. Envoyer ensuite n'importe quel sticker.
    ![devtools1](screenshots/devtools.png)
 6. Cliquer sur `Modifier` et remplacer tout par le code suivant en n'oubliant pas de modifier
    les champs "url" et "sender" avec les infos correspondantes :
@@ -77,29 +91,60 @@ Pour cela :
 7. Actualiser Element  
 Vous avez maintenant un stickerpicker pouvant envoyer des stickers privacy\_pam.
 
+## Utiliser un pack de sticker
+Dans le dossier `pack` de ce dépôt sont regroupés tout les packs de sticker créé par des IIEns.  
+Pour en ajouter un dans le stickerpicker, allez voir ce
+[tutoriel](https://git.iiens.net/Tigriz/matrix-stickers/-/tree/master/packs).  
+
 ## Créer des packs de stickers
-Un pack de stickers se résume à un fichier json dans le dossier `packs` possédant des informations précises sur les images téléversées. Pour créer ce ficher json et téléverser ses images, il existe deux méthodes :  
+Avec le nouveau stickerpicker installé, il est possible de créer ses propres packs de stickers.
+Un pack de stickers se résume à un fichier json possédant des informations précises sur les images téléversées. 
+- Note 1  : Il est conseillé de créer un compte secondaire sur matrix.org pour créer les packs de stickers. Si vous utilisez votre compte Arise,
+il est possible que vos packs ne soient plus disponibles, car Arise libère de la place aléatoirement quand c'est nécessaire. Pour se créer un compte
+sur matrix.org, rendez vous [ici](https://app.element.io/#/register). Même si vos stickers seront
+hébergés sur votre compte secondaire, vous pourrez toujours utiliser le stickerpicker et envoyer les stickers avec votre compte Arise.
+- Note 2 : Il est déconseillé d'effectuer cette étape sur perso.iiens.net. Préférez le faire sur votre machine car cette étape nécessite 
+le paquet "ImageMagick" qui n'est pas à jour sur perso.iiens.net ( impossible de le maj ) et casse la transparence de vos images. Si vous souhaitez
+tout de même le faire sur perso.iiens.net, vous pouvez recompiler à la main le paquet, je vous laisse chercher comment faire.
+
+Pour créer ce ficher json et téléverser ses images, il existe deux méthodes :  
 
 ### Méthode automatique
 **Via le script matrixpack.sh**  
 **Requis** : *ImageMagick* (`sudo apt-get install imagemagick`/`pacman -S imagemagick`).  
+Ce script suppose que vous avez déjà créer un ou plusieurs dossiers regroupant les images que vous souhaitez utiliser en sticker.
+Le nom du dossier définira le nom du pack, et les images s'y trouvant deviendront les stickers du pack.
 1. Cloner ce dépôt
-2. Récupérer le **token** de son compte en allant dans `Tout les paramètres` -> `Aide & À propos` -> `Avancé`. Dans la dernière ligne `Jeton d'accès` cliquer pour l'afficher.
-3. Exécuter `./matrixpack.sh token homeserver directory...`  
-Note : Le (ou les) dossier cible `directory` correpond au dossier contenant vos images à téléverser.  
-**Ne le faites pas avec votre compte arise, les images pourront être supprimées aléatoirement**, faites-vous un compte sur matrix.org.  
+  ```bash
+  git clone https://git.iiens.net/Tigriz/matrix-stickers.git
+  ```
+2. Se connecter à Element et récupérer le **token** de son compte en allant dans 
+   `Tout les paramètres` -> `Aide & À propos` -> `Avancé`. Dans la dernière ligne `Jeton d'accès` cliquer pour l'afficher.  
+3. Exécuter le script matrixpack.sh  
+  ```bash
+  cd matrix-stickers
+  ./matrixpack.sh token homeserver directory1 directory2...
+  ```  
+- Note : Le (ou les) dossier cible `directory` correpond au dossier contenant vos images à téléverser.  
 Le script crée un nouveau sous-dossier dans `directory` contenant trois fichiers:  
     - nomdupack.json : le json des stickers téléversés, rognés, de taille 128x128, sans palette indexée (qui casse la transparence)  
     - preview.png : une prévisualisation des images en mosaïque avec **ImageMagick**  
-    - README.md: affichant la prévisualisation  
+    - README.md: Permet d'afficher les stickers du pack dans git  
 4. Ajouter le json des stickers téléversés (nomdupack.json) dans le dossier `packs`.  
+  ```bash
+  cp nomdupack.json ~/html/stickerpicker/web/packs
+  ```
 **Précision** : si vous avez exécuté le script hors de votre perso, vous devez envoyer le ficher json par ssh.  
-Pour cela faites `scp nomdupack.json nom0000@perso.iiens.net:html/stickerpicker/web/packs/`.  
+  ```bash
+  scp nomdupack.json nomArise@perso.iiens.net:~/html/stickerpicker/web/packs
+  ```
 Cela va copier le fichier nomdupack.json dans le dossier `packs` se trouvant dans votre perso.  
-5. Mettre à jour le fichier `index.json` en suivant le modèle de l'étape 3 (Avoir un meilleur sticker picker).
+5. Mettre à jour le fichier `index.json` se trouvant dans `~/html/stickerpicker/web/packs`.
 
 **Facultatif :**
-Vous pouvez ajouter directement le nouveau sous-dossier créé par le script dans ce dépôt et ainsi contribuer!
+Vous pouvez aussi ajouter le nouveau sous-dossier créé par le script dans ce dépôt et ainsi contribuer!
+Pour cela faites une pull request.
+
 
 **Tips**
 ```bash

index.json

-{"homeserver_url":"https://matrix.org","packs":["matrix-stickers/packs/aoppoid/aoppoid.json","matrix-stickers/packs/apple-flower/apple-flower.json","matrix-stickers/packs/autres/autres.json","matrix-stickers/packs/bloodborne-gif/bloodborne-gif.json","matrix-stickers/packs/bluerabredcat/bluerabredcat.json","matrix-stickers/packs/crop/crop.json","matrix-stickers/packs/eliteactu/eliteactu.json","matrix-stickers/packs/fachosphere/fachosphere.json","matrix-stickers/packs/francais/francais.json","matrix-stickers/packs/japanesekitty/japanesekitty.json","matrix-stickers/packs/jvc/jvc.json","matrix-stickers/packs/larry/larry.json","matrix-stickers/packs/logh/logh.json","matrix-stickers/packs/madoka-magica/madoka-magica.json","matrix-stickers/packs/madokamisc/madokamisc.json","matrix-stickers/packs/magia-record/magia-record.json","matrix-stickers/packs/pack-hanayo/pack-hanayo.json","matrix-stickers/packs/pack-hii/pack-hii.json","matrix-stickers/packs/pepe/pepe.json","matrix-stickers/packs/pepetop/pepetop.json","matrix-stickers/packs/pikachudetective/pikachudetective.json","matrix-stickers/packs/popocolorin/popocolorin.json","matrix-stickers/packs/prettysailormoon/prettysailormoon.json","matrix-stickers/packs/pusheen02/pusheen02.json","matrix-stickers/packs/pusheen/pusheen.json","matrix-stickers/packs/qlf/qlf.json","matrix-stickers/packs/raoult/raoult.json","matrix-stickers/packs/risitas/risitas.json","matrix-stickers/packs/shotacollectionpack/shotacollectionpack.json","matrix-stickers/packs/weeb/weeb.json","matrix-stickers/packs/wojak/wojak.json","matrix-stickers/packs/xanaduavici/xanaduavici.json"]}
\ No newline at end of file

packs/README.md

-# Packs
+Ce dossier regroupe tout les packs de stickers qu'ont créé les IIEns.
+Il est possible de visualiser les stickers en allant dans le dossier d'un des packs.  
 
-Déposez vos packs ici.  
-Il est conseillé de mettre un README avec un aperçu tel que produit par le script `matrixpack.sh`.
\ No newline at end of file
+# Utiliser un pack de sticker  
+Vous pouvez utiliser n'importe quel pack disponible ici.
+Pour cela:
+1. Télecharger le fichier nomdupack.json du pack de sticker.  
+2. Ajouter-le au dossier pack de votre stickerpicker  
+  ```bash
+  cp nomdupack.json ~/html/stickerpicker/web/packs
+  ```  
+3. Mettre à jour le fichier index.json se trouvant dans le dossier packs de votre stickerpicker.  
+
+
+# Déposer un pack de sticker
+Déposez vos packs ici, vous pouvez faire une pull request.
+Il est conseillé de mettre un README avec un aperçu tel que produit par le script `matrixpack.sh`.