modification du README et ajout de la licence

2024-10-28 23:30:00 +01:00
parent 4fe4161d94
commit 1679d25295
2 changed files with 103 additions and 40 deletions
--- a/21
+++ b/21
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 [Angels-dev] & [Betasown]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
--- a/README.md
+++ b/README.md
@@ -1,58 +1,100 @@
-# MultiMinesweeper-Game
-Online Multiplayer game of Minesweeper
+# Démineur - Jeu réalisé avec Vue.js (Mode Solo et Multijoueur)

-# Vue Init
-This template should help get you started developing with Vue 3 in Vite.
+Ce projet est une version moderne du classique jeu Démineur, développé avec [Vue.js](https://vuejs.org/), un framework JavaScript. En plus du mode solo, le jeu intègre un mode multijoueur en cours de développement pour une expérience encore plus engageante.

-## Recommended IDE Setup
+## Table des matières
+- [Aperçu](#aperçu)
+- [Fonctionnalités](#fonctionnalités)
+- [Prérequis](#prérequis)
+- [Installation](#installation)
+- [Utilisation](#utilisation)
+- [Technologies Utilisées](#technologies-utilisées)
+- [Contributeurs](#contributeurs)
+- [Licence](#licence)

-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
+## Aperçu

-## Type Support for `.vue` Imports in TS
+Le Démineur est un jeu de logique dans lequel le joueur doit identifier et marquer toutes les cases contenant des mines dans une grille. Le but est d'éviter les mines tout en dévoilant le plus de cases possible. Ce projet est une excellente introduction aux concepts de réactivité et de gestion d’événements dans Vue.js, avec en plus l'intégration d'un mode multijoueur pour jouer en ligne contre vos amis.

-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
+Vous pouvez jouer au jeu directement en ligne sur [https://minesweeper.zac.ovh/](https://minesweeper.zac.ovh/)

-## Customize configuration
+## Fonctionnalités

-See [Vite Configuration Reference](https://vite.dev/config/).
+- **Mode Solo** : Profitez du jeu classique avec des niveaux de difficulté ajustables (facile, moyen, difficile).
+- **Mode Multijoueur (en développement)** : Jouez contre vos amis en temps réel et tentez de marquer plus de cases qu'eux sans toucher de mines.
+- **Génération aléatoire des mines** : Les mines sont placées aléatoirement pour chaque nouvelle partie.
+- **Marquage de cases** : Utilisez le clic droit pour marquer une case soupçonnée de contenir une mine.
+- **Affichage dynamique** : La grille est mise à jour en temps réel en fonction des actions du joueur.
+- **Gestion d'état** : Utilisation des fonctionnalités de Vue.js pour la gestion de l'état du jeu et des données de grille.
+- **Temps de jeu et score** : Un compteur de temps pour suivre les performances du joueur.

-## Project Setup
+## Prérequis

-```sh
-npm install
-```
+Avant de commencer, assurez-vous d'avoir les éléments suivants installés sur votre machine :

-### Compile and Hot-Reload for Development
+- [Node.js](https://nodejs.org/) (version 12 ou supérieure)
+- [npm](https://www.npmjs.com/) ou [Yarn](https://yarnpkg.com/)

-```sh
-npm run dev
-```
+## Installation

-### Type-Check, Compile and Minify for Production
+1. Clonez le dépôt GitHub :
+   ```bash
+   git clone https://github.com/votre-utilisateur/demineur-vue.git
+   ```

-```sh
-npm run build
-```
+2. Naviguez dans le répertoire du projet :
+   ```bash
+   cd demineur-vue
+   ```

-### Lint with [ESLint](https://eslint.org/)
+3. Installez les dépendances :
+   ```bash
+   npm install
+   ```
+   ou
+   ```bash
+   yarn install
+   ```

-```sh
-npm run lint
-```
+## Utilisation

-## Fonctionnement du jeu    
+1. Lancez le serveur de développement :
+   ```bash
+   npm run dev
+   ```
+   ou
+   ```bash
+   yarn dev
+   ```

-case appuis :
-    -> case découverte X
-        ->bombe ? X
-            ->game over X
-        ->while casevide ? X 
-            -> découverte case vide X
-                ->etc... X 
-            -> case numéro ? X 
-                ->découverte case numéro
-                    ->end 
-        -> case numéro ? X 
-            ->découverte case numéro
-                ->end
+2. Ouvrez votre navigateur et accédez à `http://localhost:8080` pour voir le jeu Démineur.
+
+3. Pour construire le projet pour la production :
+   ```bash
+   npm run build
+   ```
+   ou
+   ```bash
+   yarn build
+   ```
+
+## Technologies Utilisées
+
+- **Vue.js** - Framework JavaScript pour construire des interfaces utilisateur réactives.
+- **JavaScript (ES6+)** - Langage de programmation principal pour la logique du jeu.
+- **HTML5 & CSS3** - Pour le rendu et le style de l'interface.
+- **Vue CLI** - Outil en ligne de commande pour gérer la configuration du projet Vue.js.
+
+## Contributeurs
+
+- **[@angels-dev](https://github.com/angels-dev)** - Alternant Ingénieur Réseau et développeur
+- **[@betasown](https://github.com/betasown)** - Etudiant en informatique et développeur
+
+## Licence
+
+Ce projet est sous licence MIT - voir le fichier [LICENSE](LICENSE) pour plus de détails.
+
+## Remarque sur le mode Multijoueur
+
+Le mode multijoueur est encore en développement. Nous travaillons activement à l'ajout de nouvelles fonctionnalités telles que la connexion entre joueurs, les classements, et les interactions en temps réel. Restez à l'affût des mises à jour !