Merge branch 'readme' into 'master'

Modification du Readme et du script

See merge request Tigriz/matrix-stickers!1

README.md

 # Matrix Stickers
-Repo regroupant les informations relatives aux stickers custom et différents pack de stickers créés par les IIEns
+Repo regroupant les différents pack de stickers créés par les IIEns et les informations relatives aux stickers custom.
 
 ## Avoir un meilleur sticker picker et des stickers perso
-1. Copier le contenu du [stickerpicker](https://github.com/maunium/stickerpicker) dans votre perso (dans le dossier html) ou votre site web
-2. Placer le dossier `packs` dans le dossier `web`
+1. Cloner le repo [stickerpicker](https://github.com/maunium/stickerpicker) dans votre perso (dans le dossier html) ou sur votre site web. (Pour accéder à son perso : `ssh loginArise@perso.iiens.net`)
+2. Dans le repo, placer le dossier `packs` dans le dossier `web`
 3. Créer un fichier `index.json` dans `packs` avec un contenu de cette forme :
 ```json
 {
-  "homeserver_url": "https://example.com", // Vous pouvez mettre matrix.org ou matrix.iiens.net
+  "homeserver_url": "https://example.com", 
+  // Vous pouvez mettre https://matrix.iiens.net si vous n'avez que le compte que vous a créé Arise.
   "packs": [
-    "nom_des_packs.json", // Vous pouvez donc ne pas mettre un pack qui est dans le dossier packs
-    "another_telegram_imported_pack.json"
+    "nom_des_packs.json", 
+    // Par exemple scalar-privacy_pam.json, vous pouvez donc choisir de ne pas mettre un pack qui est dans le dossier packs.
+    "another_telegram_imported_pack.json" // Exemple
   ]
 }
 ```
-4. Sur Element web/bureau `/devtools` (dans un tchat)
-5. `Explorer les données du compte`
-6. `m.widget` (si absent, le créer)
-7. Entrer
+4. Utiliser la commande `/devtools` dans un tchat element. (TODO image)
+5. Cliquer sur `Explorer les données du compte` puis sur `m.widgets` (si absent, le créer) ## Comment le créer?
+7. Cliquer sur `Modifier` et remplacer tout par :
 ```json
 {
     "stickerpicker": {
         "content": {
             "type": "m.stickerpicker",
-            "url": "https://nomdefamille.iiens.net/dossier/web/?theme=$theme", // TODO
+            "url": "https://nomdefamille.iiens.net/stickerpicker/web/?theme=$theme", 
+            // TODO mettre son nomdefamille tronqué à 8 caractères.
             "name": "Stickerpicker",
             "data": {}
         },
-        "sender": "@id:homeserver", // TODO
+        "sender": "@loginArise:homeserver", 
+        // TODO homeserver=matrix.iiens.net pour le compte créé par Arise.
         "state_key": "stickerpicker",
         "type": "m.widget",
         "id": "stickerpicker"
     }
 }
 ```
+   N'oubliez pas de supprimer les // TODO.
+
 8. Actualiser Element
 
 ## Créer des packs de stickers
-Pour créer un pack de stickers, il suffit de créer un fichier .json dans le dossier `packs` et d'y indiquer les informations nécessaires.
+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 :
 
 ### Méthode automatique
 **Via le script matrixpack.sh**  
-Requis : **ImageMagick**  
-Le dossier cible sera le nom du pack de stickers.  
-`./matrixpack.sh token homeserver directory` en récupérant le **token** de son compte dans `Help & About`, `Advanced`, à la dernière ligne.  
-Le script donne un nouveau sous-dossier contenant :
+Requis : **ImageMagick** (Pour l'installer `sudo apt-get install imagemagick`).  
+Le dossier cible `directory` est le dossier contenant vos images à téléverser.  
+Exécuter `./matrixpack.sh token homeserver directory` en récupérant le **token** de son compte dans `Tout les paramètres` -> `Aide & À propos` -> `Avancé`, à la dernière ligne dans `Jeton d'accès`.  
+Le script crée un nouveau sous-dossier dans `directory` contenant :
 - le json des stickers téléversés, rognés proprement, de taille 128x128, sans palette indexée (qui casse la transparence)
 - une prévisualisation des images en mosaïque avec **ImageMagick**
 - un README.md affichant la prévisualisation
 
 Vous pouvez donc ajoutez directement le dossier de sortie du script dans ce repo !  
+Il faut ensuite ajouter le json des stickers téléversés dans le dossier `packs` et mettre à jour le fichier `index.json`.  
+**Précision** : si vous avez exécuter le script hors de votre perso, vous devez envoyer le ficher json par ssh.  
+Pour cela faites `scp fichier.json loginArise@perso.iiens.net:~/html/stickerpicker/web/packs/`.  
+Cela va copier le fichier json dans le dossier `packs` se trouvant dans votre perso.  
+Mettez ensuite le ficher `index.json` à jour.
 
 ### Méthode manuelle
 1. Téléverser une image dans un salon non-chiffré

matrixpack.sh

@@ -20,6 +20,7 @@ fi
 # Checking if ImageMagick is installed
 if ! command -v magick &> /dev/null; then
     echo "$0:ERROR: magick could not be found"
+    echo "Usage : ./matrixpack.sh token homerserver directory"
     exit
 fi