From cc1f11e69996f7e0bd9495b5c480a49988d0ff58 Mon Sep 17 00:00:00 2001 From: Leo VIALLON-GALINIER Date: Sun, 3 May 2020 13:01:02 +0200 Subject: [PATCH] Enhance README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 5ff83cb..9525554 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Jeu de belote en ligne basé sur flask et socket.io. +Ce dépôt est sous licence GPL v3. Voir [le texte de la licence en ligne](https://www.gnu.org/licenses/gpl-3.0.html). + ## Installation 1. Créer un environnement virtuel `venv` (`python3 -m venv venv`) @@ -13,3 +15,11 @@ Jeu de belote en ligne basé sur flask et socket.io. * Cartes : Inspiré de SVG-cards par David Bellot * Design : Camille Viallon + +## Principe + + * `belote.py` définit les routes + * `db.py` gère le jeu et l'enregistrement en base de donnée + * `belote_ws.py` gère l'interactivité (avec des websockets) + * Le dossier `templates` contient les template jinja2 pour le rendu web + * Le dossier `static` contient les scripts, images et feuilles de style