From 38b4515d15d334fdc517211f42fea79f64dbc959 Mon Sep 17 00:00:00 2001 From: Lucie Bader <bader.lucie@gmail.com> Date: Thu, 20 Feb 2025 21:23:00 +0000 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++---------------------------- 1 file changed, 9 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index dc3ab9b..9d96e43 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,26 @@ -# balex2ff -Un projet de plugin firefox qui interagirait avec [balex](https://balex.liris.cnrs.fr/)… +# Extension Firefox - ff2balex +Un projet de plugin Firefox qui interagit avec [BaLex](https://balex.liris.cnrs.fr/). Ce projet s'inscrit dans la continuité du projet [Lex:gaMe](https://aslan.universite-lyon.fr/projet-lex-game-233220.kjsp). -## Resources -* [solution pour échanger avec un script python](https://developer.mozilla.org/fr/docs/Mozilla/Add-ons/WebExtensions/Native_messaging) -* [a-t-on besoin de scripts de contenu ? — probablement que oui](https://developer.mozilla.org/fr/docs/Mozilla/Add-ons/WebExtensions/Content_scripts) +Toutes les informations sur **le fonctionnement et l'utilisation** de cette extension sont disponibles à partir de [cette page](https://gitlab.liris.cnrs.fr/lex-game/balex2ff/-/wikis/home). -## Wiki Lex:gaMe -> https://wiki.lezinter.net/_/LexgaMe:Ff2balex +L'**installation** est à ce jour manuelle. La procédure est détaillée [ici](https://gitlab.liris.cnrs.fr/lex-game/balex2ff/-/wikis/Documentation/Utilisation-de-l'extension/Installation). -## Licence -> MIT ? à définir -Plug-in réalisé dans le cadre du projet [Lex:gaMe](https://aslan.universite-lyon.fr/projet-lex-game-233220.kjsp) +### Ressources +* [Solution pour échanger avec un script python](https://developer.mozilla.org/fr/docs/Mozilla/Add-ons/WebExtensions/Native_messaging) +* [A-t-on besoin de scripts de contenu ? — probablement que oui](https://developer.mozilla.org/fr/docs/Mozilla/Add-ons/WebExtensions/Content_scripts) -## Installation de l'extension (module complémentaire temporaire) -- Télécharger le dossier complet -- Ouvrir Firefox et accéder aux modules complémentaires (Ctrl + Shift + A (Windows/Linux) ou Cmd + Shift + A (Mac)) -- Cliquer sur l'icône en haut à droite puis sur "Déboguer des modules" -- Cliquer sur "Charger un module complémentaire temporaire" -- Sélectionner le fichier 'manifest.json' -- Pour veiller au bon fonctionnement du worker de l'extension, désactiver l'option "Utiliser toujours le mode de navigation privée" voir [lien](https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html#service-workers-not-compatible). - -## Connexion/Déconnexion de l'utilisateur via le menu de l'extension -Via un bouton de connexion/déconnexion dans le menu de l'extension, l'utilisateur accède à la page d'authentification de [Prisms](https://prisms.lezinter.net/fr/login), complète ses informations de connexion et doit cliquer sur "Se connecter avec BaLex". Le script récupère ensuite le token d'authentification et le stocke dans le LocalStorage. -Si l'utilisateur clique sur le bouton "Se déconnecter" de l'extension, le token est supprimé. - -## Activation des statistiques : -Cliquer sur le bouton "Activer les statistiques". -Lorsqu’un utilisateur se connecte, il peut activer l'ajout automatique des mots dans les lexiques personnels sélectionnés et fixer un seuil d'ajout (Cliquer sur le bouton "Valider" après avoir fixé un seuil et sélectionné au moins une langue). - -## Crédits +### Crédits * [`link_to_balex.svg`](/src/assets/icons/Link_to_balex.svg) MIT https://www.svgrepo.com/svg/450128/external-link-s * TODO : mettre les autres crédits (dépendances — ex pyodide, images, fonts) ---- **Police utilisée : Luciole** Conçue spécifiquement pour les personnes malvoyantes. © Laurent Bourcellier & Jonathan Perez – Distribuée gratuitement sous la [Licence Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/legalcode.fr). Source : [Luciole Vision](https://luciole-vision.com/) + **Icônes** Création des icônes d'options sur [icones8](https://icones8.fr/icons) -- GitLab