diff --git a/Makefile b/Makefile index 9754ad5..494cd77 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,9 @@ TESTS = $(wildcard build/test*) all: + npx webpack --mode production + +dev: npx webpack --mode development zip: diff --git a/README b/README new file mode 100644 index 0000000..1ecff3e --- /dev/null +++ b/README @@ -0,0 +1,83 @@ +# 🀄 Tutoriel interactif de Mahjong 🀄 +Un tutoriel complet et interactif pour apprendre Ă  jouer au mahjong, dĂ©veloppĂ© en TypeScript. Ce projet vise Ă  rendre l'apprentissage du mahjong accessible Ă  tous. + + + +## 🔗 DĂ©monstration + +Ce tutoriel est accessible directement sur [ce site](https://perso.eleves.ens-rennes.fr/people/adrien.decosse/riichi/). + + + +## ✹ FonctionnalitĂ©s + +- Guide Ă©tape par Ă©tape: Apprentissage progressif dĂ©coupĂ© en chapitre +- Interface interactive: Manipulez les tuiles et expĂ©rimenter les dynamiques +- Exemples de jeu: ScĂ©narios dirigĂ©s pour s'entrainer aux diffĂ©rentes situations +- Non compatible pour le format tĂ©lĂ©phone ou tablette + + + +## đŸ› ïž Configuration Typescript + +- Cible ES2015 +- Mode strict activĂ© +- Module de type "esnext" + + + +## đŸ› ïž PrĂ©requis + +- ts-loader ^9.5.2 +- webpack ^5.98.0 +- webpack-cli ^6.0.1 + + + +## 🚀 Installation + +- Clonage du dĂ©pot: ```git clone https://github.com/Didictateur/Riichi.git && cd Riichi``` +- Installation des dĂ©pendances: ```npm install``` +- Compilation: ```make``` + + + +## Ⓜ Makefile + +Un makefile est Ă  disposition pour exĂ©cuter plusieurs commandes: + +- `make` compile le projet dans `build/` en mode `production` +- `make dev` compile le projet dans `build/` en mode `development` +- `make zip` compresse le contenu du `build` et les ressource nĂ©cessaires dans `riichi.zip` +- `make clean` supprime `riichi.zip` et le contenu de `build/` +- `make hard-clean` en plus de clean, supprime toutes les dĂ©pendances installĂ©es + + + +## 📁 Structure du projet + +``` +Riichi/ +├── src/ +│ ├── img/ # Dossier contenant les images +│ ├── display/ # Composant gĂ©rant l'affichage de chaque section +│ ├── text/ # Textes des tutoriels +│ ├── yakus/ # ImplĂ©mentation des yakus +│ └── [autres fichiers sources] +├── img/ # Images et ressources +├── tests/ # Tests unitaires et d'intĂ©gration +├── build/ # Ensemble du projet compilĂ© en JavaScript +└── [autres fichiers de configuration] +``` + + + +## đŸ€ Source + +Les images ont Ă©tĂ© rĂ©cupĂ©rĂ©es depuis le github de [FluffyStuff](https://github.com/FluffyStuff/riichi-mahjong-tiles?tab=readme-ov-file). + + + +## 📝 Licence + +Tout le projet est dans le [domaine public](https://creativecommons.org/publicdomain/zero/1.0/). diff --git a/index.html b/index.html index 90eda66..c6fed88 100644 --- a/index.html +++ b/index.html @@ -65,6 +65,9 @@