documentation #2

Open
lseys wants to merge 8 commits from documentation into develop
3 changed files with 28 additions and 22 deletions
Showing only changes of commit 16f5e1873d - Show all commits

View File

@ -76,7 +76,7 @@ ${HOME}/.config/arcast-player/
└── custom └── custom
``` ```
Nous avons une image **logo.png**, un fichier css pour l'apparence **exemple.css**, et un templates **index.gohtml** dans le dossier _templates, contenant le texte à afficher, et sa position dans la fenêtre. Nous avons une image **logo.png**, un fichier css pour l'apparence **exemple.css**, et un template **index.gohtml** dans le dossier `_templates`, contenant le texte à afficher, et sa position dans la fenêtre.
Soit : Soit :
@ -99,7 +99,7 @@ Une fois les fichiers dûments remplis, il suffit de lancer, ou re-lancer arcast
<h1 style="margin-top: 20px" class="text-centered">Bienvenue chez moi !</h1> <h1 style="margin-top: 20px" class="text-centered">Bienvenue chez moi !</h1>
<hr style="margin: 20px 0 20px 0" /> <hr style="margin: 20px 0 20px 0" />
<div style="margin: 20px 0 20px 0"> <div style="margin: 20px 0 20px 0">
<p>Pensez à vous essuyer les pieds</p> <p>Pensez à vous essuyer les pieds</p>
<ul> <ul>
<li> <li>
<b style="width: 33%; display: inline-block">Pour la bière:</b> <b style="width: 33%; display: inline-block">Pour la bière:</b>
@ -120,3 +120,7 @@ Une fois les fichiers dûments remplis, il suffit de lancer, ou re-lancer arcast
{{ template "base" . }} {{ template "base" . }}
{{ end }} {{ end }}
``` ```
Exemple de rendu avec logo cadoles.
![exemple](./resources/arcast-exemple.png)

View File

@ -8,7 +8,7 @@
# Installation # Installation
Les paquets sont actuellement générés, et fonctionnel pour : Les paquets sont actuellement générés, et fonctionnels pour :
architecture : architecture :
@ -24,7 +24,7 @@ OS :
- android - android
- .apk - .apk
Leur téléchargement pour les version linux sont disponible sur : [arcast-cadoles](https://forge.cadoles.com/arcad/arcast/releases) Leurs téléchargements pour les versions linux sont disponibles sur : [arcast-cadoles](https://forge.cadoles.com/arcad/arcast/releases)
**arcast-client**: permet d'envoyer des flux sur les players **arcast-client**: permet d'envoyer des flux sur les players
@ -34,9 +34,9 @@ Leur téléchargement pour les version linux sont disponible sur : [arcast-cadol
L'App android est déployée sur [https://fdroid.cadol.es/repo/](https://fdroid.cadol.es/repo/) L'App android est déployée sur [https://fdroid.cadol.es/repo/](https://fdroid.cadol.es/repo/)
Pour ajouter ce repo utilisez F-droid. (paramètre/depôt cliquer sur **+**) Pour ajouter ce repo utilisez [F-droid](https://f-droid.org/fr/). (paramètre/depôt cliquer sur **+**)
Arcast Player apparaîtra dans les nouveautées. Une fois installé, ouvrir f-droid, Arcast Player apparaîtra dans les nouveautées.
## Arcast-player & client ## Arcast-player & client

View File

@ -2,21 +2,21 @@
- [Linux](#linux) - [Linux](#linux)
- [Arcast-player en ligne de commande](#arcast-player-en-ligne-de-commande) - [Arcast-player en ligne de commande](#arcast-player-en-ligne-de-commande)
- [Arcast-client en ligne de commande](#arcast-client-en-ligne-de-commande) - [Arcast-client en ligne de commande](#arcast-client-en-ligne-de-commande)
- [démarrer un cast](#démarrer-un-cast) - [Démarrer un cast](#démarrer-un-cast)
- [scan](#scan) - [Scan](#scan)
- [status](#status) - [Status](#status)
- [reset](#reset) - [Reset](#reset)
- [Arcast-player affichage](#arcast-player-affichage) - [Arcast-player affichage](#arcast-player-affichage)
# Usage # Usage
## Linux ## 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é. Vous pouvez lancer arcast grâce à son icône 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 de choisir le mode sus-mentionné.
### Arcast-player en ligne de commande ### Arcast-player en ligne de commande
Pour afficher les commandes disponible : Pour afficher les commandes disponibles :
`arcast-player -help` `arcast-player -help`
@ -35,7 +35,7 @@ Afficher les commandes disponibles:
`arcast-client -help` `arcast-client -help`
Il y a quatre commande disponibles hors help : Il y a quatre commandes disponibles hors help :
- cast - cast
- reset - reset
@ -43,9 +43,9 @@ Il y a quatre commande disponibles hors help :
- status - status
- help - help
chaucune peut prendre des options particulière, pour les voir `arcast-client [commande] -help` Chacune peut prendre des options particulières, pour les consulter `arcast-client [commande] -help`
#### démarrer un cast #### 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` 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`
@ -55,7 +55,7 @@ exemple :
user@localhost$ arcast-client cast --player-address 192.168.10.197:45555 https://www.cadoles.com user@localhost$ arcast-client cast --player-address 192.168.10.197:45555 https://www.cadoles.com
``` ```
#### scan #### Scan
Vous pouvez scanner le réseau actuel pour détecter tous les **arcast-player** en route. Vous pouvez scanner le réseau actuel pour détecter tous les **arcast-player** en route.
@ -69,9 +69,9 @@ user@localhost$ arcast-client scan
+-----------------------+-----------------------------------+-------+ +-----------------------+-----------------------------------+-------+
``` ```
#### status #### Status
De même, il est possible d'afficher les arcast-player utilisé, et afficher ce qui est casté. De même, il est possible d'afficher les arcast-player utilisés, et afficher ce qui est casté.
```Shell ```Shell
user@localhost$ arcast-client status user@localhost$ arcast-client status
@ -83,9 +83,9 @@ user@localhost$ arcast-client status
+-----------------------+----------------------+---------+-------------------+--------------------------+ +-----------------------+----------------------+---------+-------------------+--------------------------+
``` ```
#### reset #### Reset
Vous pouvez stopper tous les caste en cours. Vous pouvez stopper tous les castes en cours.
```Shell ```Shell
user@localhost$ arcast-client reset user@localhost$ arcast-client reset
@ -98,13 +98,15 @@ user@localhost$ arcast-client reset
## Arcast-player affichage ## Arcast-player affichage
Rappel, pour lancer un player : `arcast-player run`
Vous avez démarré un player, une fenêtre c'est ouverte comme suivant : Vous avez démarré un player, une fenêtre c'est ouverte comme suivant :
![image-arcast-player](./resources/arcast-player-run.png) ![image-arcast-player](./resources/arcast-player-run.png)
Dans les zones **Address** et **Apps** vous avez les IP sur lesquelles le cast est disponible. 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**. Depuis votre poste, ou un autre entrer 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. Accepter le risk, (advanced/accept the risk and continue). Vous aurez la même page, cliquer sur l'adresse dans **Apps** qui correspond.
@ -112,6 +114,6 @@ Accepter le risk, (advanced/accept the risk and continue). Vous aurez la même p
Vous pourrez depuis cette interface : Vous pourrez depuis cette interface :
1. soit partager votre écran, pour cela cliquer sur **Screen sharing**, puis choississez ce que vous voulez partager. 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 2. Soit entrer une adresse web, et lancer un cast de la page choisit
3. Soit désactiver un cast en cliquant sur reset 3. Soit désactiver un cast en cliquant sur reset