doc: create doc usage for user

2024-04-30 15:38:54 +02:00 · 2024-04-30 15:38:54 +02:00 · 653f4cc91b
commit 653f4cc91b
parent 0a15c96339
1 changed files with 117 additions and 0 deletions
--- a/doc/usage.md
+++ b/doc/usage.md
@ -0,0 +1,117 @@
+- [Usage](#usage)
+  - [Linux](#linux)
+    - [Arcast-player en ligne de commande](#arcast-player-en-ligne-de-commande)
+    - [Arcast-client en ligne de commande](#arcast-client-en-ligne-de-commande)
+      - [démarrer un cast](#démarrer-un-cast)
+      - [scan](#scan)
+      - [status](#status)
+      - [reset](#reset)
+  - [Arcast-player affichage](#arcast-player-affichage)
+
+# Usage
+
+## Linux
+
+Vous pouvez lancer arcast grâce à son icone depuis l'interface graphique. Si vous souhaitez avoir un mode fullscreen/kiosk il suffit d'effectuer un clic droit sur l'icône de l'application et choisir le mode sus-mentionné.
+
+### Arcast-player en ligne de commande
+
+Pour afficher les commandes disponible :
+
+`arcast-player -help`
+
+pour lancer arcast-player :
+
+```Shell
+# Lancer arcast-player
+arcast-player run
+# afficher les options disponible pour lancer arcast
+arcast-player run -help
+```
+
+### Arcast-client en ligne de commande
+
+Afficher les commandes disponibles:
+
+`arcast-client -help`
+
+Il y a quatre commande disponibles hors help :
+
+- cast
+- reset
+- scan
+- status
+- help
+
+chaucune peut prendre des options particulière, pour les voir `arcast-client [commande] -help`
+
+#### démarrer un cast
+
+Effectuer un scan pour avoir les informations du client ciblé puis lancer la commande : `arcast-client cast --player-address x.x.x.x:port https://macible`
+
+exemple :
+
+```Shell
+user@localhost$ arcast-client cast --player-address 192.168.10.197:45555 https://www.cadoles.com
+```
+
+#### scan
+
+Vous pouvez scanner le réseau actuel pour détecter tous les **arcast-player** en route.
+
+```Shell
+user@localhost$ arcast-client scan
+-----------------------+-----------------------------------+-------+
+| ID                    | IPS                               | PORT  |
+-----------------------+-----------------------------------+-------+
+| 90ZiA_cZfHDvm6_XRY0uY | ["192.168.10.101","192.168.1.1... | 45555 |
+| P5UCrO16snObXr87zlPYa | ["192.168.10.197"]                | 45555 |
+-----------------------+-----------------------------------+-------+
+```
+
+#### status
+
+De même, il est possible d'afficher les arcast-player utilisé, et afficher ce qui est casté.
+
+```Shell
+user@localhost$ arcast-client status
+-----------------------+----------------------+---------+-------------------+--------------------------+
+| ID                    | ADDRESS              | STATUS  | TITLE             | URL                      |
+-----------------------+----------------------+---------+-------------------+--------------------------+
+| 90ZiA_cZfHDvm6_XRY0uY | 192.168.10.101:45555 | casting | Cadoles - Accueil | https://www.cadoles.com/ |
+| Njv7ksbvjYnCAa-WPALDI | 192.168.1.240:40931  | casting | Cadoles - Accueil | https://www.cadoles.com/ |
+-----------------------+----------------------+---------+-------------------+--------------------------+
+```
+
+#### reset
+
+Vous pouvez stopper tous les caste en cours.
+
+```Shell
+user@localhost$ arcast-client reset
+-----------------------+----------------------+--------+-----------------+-------------------------+
+| ID                    | ADDRESS              | STATUS | TITLE           | URL                     |
+-----------------------+----------------------+--------+-----------------+-------------------------+
+| 90ZiA_cZfHDvm6_XRY0uY | 192.168.10.101:45555 | idle   | Ready to cast ! | http://localhost:45555/ |
+| P5UCrO16snObXr87zlPYa | 192.168.10.197:45555 | idle   | Ready to cast ! | http://localhost:45555/ |
+```
+
+## Arcast-player affichage
+
+Vous avez démarré un player, une fenêtre c'est ouverte comme suivant :
+
+![image-arcast-player](./resources/arcast-player-run.png)
+
+Dans les zones **Address** et **Apps** vous avez les IP sur lesquelles le cast est disponible.
+
+Depuis votre poste, ou un autre entré l'adresse qui correspond à votre réseau et qui ce trouve sous **Apps**.
+
+Accepter le risk, (advanced/accept the risk and continue). Vous aurez la même page, cliquer sur l'adresse dans **Apps** qui correspond.
+
+![image-arcast-player](./resources/arcast-player-webpage.png)
+
+Vous pourrez depuis cette interface :
+
+1. soit partager votre écran, pour cela cliquer sur **Screen sharing**, puis choississez ce que vous voulez partager.
+2. Soit entrer une adresse web, et lancer un cast de la page choisit
+3. Soit désactiver un cast en cliquant sur reset