Commit 29d733ce authored by Kourser's avatar Kourser
Browse files

docs: friendlier user guide with screenshots



Rewrite the user guide with a warm, step-by-step tone, Material admonitions
(tips/notes/warning) and inline screenshots. Add docs/img/ (downscaled captures:
library, inbox, player+chapters, detail, queue, settings, iPad) and a styles.css
for polished rounded screenshots. Enable attr_list/md_in_html. MkDocs builds clean.

Co-Authored-By: default avatarClaude <claude@anthropic.com>
parent df9e9822
Loading
Loading
Loading
Loading
Loading
+100 −57
Original line number Diff line number Diff line
# Guide utilisateur

## Ajouter des podcasts
Bienvenue dans **Skingomz** 👋 — votre lecteur de podcasts pour iPhone, iPad et Mac.
Ce guide vous accompagne pas à pas, captures à l'appui.

Touchez **+** (en haut), puis :
---

- **Rechercher un podcast** — recherche dans l'annuaire Apple Podcasts ; touchez **Ajouter**.
- **Ajouter par URL** — collez l'URL d'un flux RSS (`https://exemple.com/feed.xml`).
- **Importer un fichier OPML** — pour migrer vos abonnements depuis une autre app.
## 1. Ajouter vos podcasts

Vos abonnements apparaissent dans la **Bibliothèque** (barre latérale sur iPad/Mac).
<img class="screenshot" src="../img/library.png" alt="Bibliothèque avec plusieurs abonnements">

## Nouveautés
Touchez le bouton **➕** en haut, puis choisissez :

L'entrée **Nouveautés** liste les **épisodes récents de tous vos abonnements**, du plus
récent au plus ancien. Tirez vers le bas pour actualiser les flux.
- **🔎 Rechercher un podcast** — tapez un nom, parcourez les résultats de l'annuaire
  Apple Podcasts, et touchez **Ajouter**.
- **🔗 Ajouter par URL** — collez l'adresse d'un flux RSS.
- **📂 Importer un fichier OPML** — pour récupérer vos abonnements d'une autre app.

## Bibliothèque (abonnements)
!!! tip "Astuce"
    Vous utilisez déjà une autre application ? Exportez son fichier **OPML**, puis
    importez-le ici : tous vos abonnements arrivent d'un coup.

- **Tri** : bouton de tri (en haut) → *Récents* ou *Titre*.
- **Tags / dossiers** : ouvrez un podcast → bouton **Tags** pour lui attribuer des
  étiquettes (séparées par des virgules). Filtrez ensuite la bibliothèque par tag depuis
  le bouton de tri/filtre.
- **Recherche** : la barre de recherche filtre vos abonnements **et** cherche dans les
  épisodes (résultats affichés par sections).
- **Tirer pour actualiser** : récupère les nouveaux épisodes de tous les flux.
---

## Écouter un épisode
## 2. Découvrir les nouveautés

Touchez un épisode pour lancer la lecture. Un **mini-lecteur** apparaît en bas ;
touchez-le pour ouvrir le **lecteur plein écran** :
<img class="screenshot" src="../img/inbox.png" alt="Écran Nouveautés">

- ⏯️ lecture/pause, ⏪ −15 s, ⏩ +30 s ;
- **barre de position glissable** (sur le grand lecteur **et** le mini-lecteur) ;
- **vitesse** (0,8× à 2×) ;
- **minuteur de sommeil** (🌙) : 5 à 60 min, pause automatique à la fin ;
- **chapitres** : si l'épisode en fournit, le chapitre courant s'affiche ; touchez-le
  pour voir la liste et **sauter à un chapitre**.
L'onglet **Nouveautés** rassemble les **derniers épisodes de tous vos abonnements**,
du plus récent au plus ancien — idéal pour voir ce qui vient de sortir.

La lecture continue **en arrière-plan** et sur l'**écran verrouillé** (titre, pochette,
commandes). La **position est mémorisée** : reprendre un épisode redémarre où vous
vous étiez arrêté.
!!! note
    Tirez la liste vers le bas pour **actualiser** et récupérer les nouveaux épisodes.

## File d'attente
---

- **Ajouter à la file** : appui long sur un épisode → *Ajouter à la file*.
- **File d'attente** (barre latérale) : réordonner (glisser), retirer, vider.
- L'épisode suivant s'enchaîne automatiquement à la fin du précédent.
## 3. Écouter (le lecteur)

## Téléchargements (hors-ligne)
<img class="screenshot" src="../img/player.png" alt="Lecteur plein écran">

Touchez ⬇️ sur un épisode pour le télécharger ; une fois téléchargé (✓ vert), la lecture
se fait depuis le fichier local. Pour libérer de l'espace : appui long → *Supprimer le
téléchargement*.
Touchez un épisode pour le lancer. Le **mini-lecteur** apparaît en bas ; touchez-le
pour ouvrir le **lecteur plein écran** :

## Notes & partage d'un épisode
- ⏯️ Lecture / pause, ⏪ −15 s, ⏩ +30 s
- 🎚️ **Barre de position glissable** (sur le grand lecteur **et** le mini-lecteur)
-**Vitesse** de 0,8× à 2×
- 🌙 **Minuteur de sommeil** — la lecture s'arrête toute seule après le délai choisi
- 📑 **Chapitres** — le chapitre en cours s'affiche ; touchez-le pour sauter d'un
  chapitre à l'autre

Appui long sur un épisode → **Détails / Notes** : affiche la description complète avec
**liens cliquables**, un bouton **Lire**, et le **partage**. *Partager* est aussi
accessible directement depuis le menu contextuel.
!!! tip "Bonne nuit 🌙"
    Lancez le **minuteur de sommeil** avant de vous endormir : Skingomz met la lecture
    en pause automatiquement.

## Favoris, lu/non lu, filtres
La lecture continue **en arrière-plan** et sur l'**écran verrouillé** (avec la pochette
et les commandes). Et comme la **position est mémorisée**, vous reprenez toujours là où
vous vous étiez arrêté.

- **Favori** (★) : appui long → *Ajouter aux favoris*.
- **Lu / non lu** : un épisode terminé est marqué *Lu* ; forcez l'état via le menu.
- **Filtrer les épisodes** d'un podcast : *Tous / Non lus / Favoris / Téléchargés* ;
  **tri** *Plus récents / Plus anciens*.
---

## Synchronisation entre appareils
## 4. Le détail d'un épisode

Voir [Configurer la synchronisation](Synchronisation.md) : abonnements **et** progression
de lecture, via Nextcloud (app GPodder Sync) ou gpodder.net. Configuration dans
**Réglages**.
<img class="screenshot" src="../img/detail.png" alt="Détail d'un podcast">

## Réglages
Ouvrez un podcast pour voir sa description et la **liste de ses épisodes**.

L'écran **Réglages** (barre latérale) regroupe :
Faites un **appui long** sur un épisode pour :

- la **synchronisation** (fournisseur, serveur, identifiants — mot de passe dans le
  Trousseau) ;
- l'**export OPML** de vos abonnements ;
- la **réinitialisation de l'application** (efface toutes les données — irréversible) ;
- la rubrique **À propos** (version et commit).
- **ℹ️ Détails / Notes** — la description complète, avec **liens cliquables**
- **↗️ Partager** l'épisode
- **➕ Ajouter à la file** d'attente
- **⭐ Mettre en favori**, **✓ marquer comme lu/non lu**
- **⬇️ Télécharger / supprimer** le téléchargement

En haut de l'écran, **filtrez** (Tous · Non lus · Favoris · Téléchargés) et **triez**
(plus récents / plus anciens) les épisodes.

---

## 5. La file d'attente

<img class="screenshot" src="../img/queue.png" alt="File d'attente">

Mettez des épisodes **à la suite** : ils s'enchaînent automatiquement.

- Réorganisez l'ordre en **glissant** les épisodes.
- Retirez-en, ou **videz** toute la file.

---

## 6. Organiser : favoris, filtres, tags

- **⭐ Favoris** — retrouvez vos épisodes étoilés via le filtre *Favoris*.
- **🗂️ Tags** — donnez des étiquettes à vos podcasts (bouton **Tags** sur un podcast),
  puis **filtrez** la bibliothèque par tag.
- **🔍 Recherche** — la barre de recherche cherche à la fois dans vos **abonnements**
  et dans les **épisodes**.
- **↕️ Tri** des abonnements : *Récents* ou *Titre*.

---

## 7. Synchroniser & réglages

<img class="screenshot" src="../img/settings.png" alt="Réglages">

Dans **Réglages**, vous pouvez :

- **🔄 Synchroniser** abonnements et progression avec **Nextcloud** ou **gpodder.net**
  (voir [Configurer la synchronisation](Synchronisation.md)) ;
- **📤 Exporter** vos abonnements en **OPML** ;
- **🧹 Réinitialiser** l'application (efface toutes les données — irréversible) ;
- consulter la **version** et le **commit** dans *À propos*.

!!! warning "Réinitialisation"
    *Réinitialiser l'application* supprime **définitivement** abonnements, épisodes,
    téléchargements, file, progression et réglages. Une confirmation est demandée.

---

## Sur iPad et Mac

<img class="screenshot-wide" src="../img/ipad.png" alt="Skingomz sur iPad">

Sur grand écran, Skingomz affiche une **barre latérale** (rubriques + abonnements) et un
**volet de détail** côte à côte. Sur iPhone, la même interface se replie en navigation
classique.

docs/img/detail.png

0 → 100644
+185 KiB
Loading image diff...

docs/img/inbox.png

0 → 100644
+145 KiB
Loading image diff...

docs/img/ipad.png

0 → 100644
+143 KiB
Loading image diff...

docs/img/library.png

0 → 100644
+208 KiB
Loading image diff...
Loading