diff --git a/Documentation/doc_images/bowling-157933.png b/Documentation/doc_images/bowling-157933.png new file mode 100644 index 0000000..df83299 Binary files /dev/null and b/Documentation/doc_images/bowling-157933.png differ diff --git a/README.md b/README.md index db35a73..4ae73b2 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,82 @@ Welcome on the BowlingScoreApp project! + -_Generated with a_ **Code#0** _template_ - \ No newline at end of file +## Description + +Ce projet est une application de gestion de score de bowling. +l'application vas permettre de: + +* Gérer les scores de plusieurs joueurs en même temps. +* Gérer les matchs en équipe, en individuel ou en solo. +* consulter les statistiques des joueurs. +* consulter les statistiques des matchs. +* Consulter l'historique des matchs. + + +## Installation + +### Requirements + +* C# 8.0 +* .NET Core 6.0 +* Visual Studio 2022 +* Entity Framework Core 6.0 +* SQLite 3.36.0 +* xUnit 2.4.1 + +### Clone + +Clone this repo to your local machine using `https://codefirst.iut.uca.fr/victor_perez.ngounou/BowlingScoreApp.git` + +* [Git](https://git-scm.com) - Download and Install Git. +* [Visual Studio](https://visualstudio.microsoft.com/fr/) - Download and Install Visual Studio. +* [SQLite](https://www.sqlite.org/index.html) - Download and Install SQLite. +* [xUnit](https://xunit.net/) - Download and Install xUnit. +* [Entity Framework Core](https://docs.microsoft.com/fr-fr/ef/core/) - Download and Install Entity Framework Core. + +### Install Entity Framework Core Tools + +```shell +$ dotnet tool install --global dotnet-ef +``` + +### Setup + +* Ouvrir le projet dans Visual Studio. +* Lancez le projet en mode debug. +* Dans le menu déroulant, sélectionnez "BowlingApp" puis "Package Manager Console". +* Dans la console, tapez la commande suivante: + +```shell +Update-Database +``` + +* L'application est prête à être utilisée. + +## Usage + +* Open the solution in Visual Studio 2022 +* Build the solution +* Run the application + +## Contributeurs + +* [Victor Perez NGOUNOU](https://codefirst.iut.uca.fr/victor_perez.ngounou) +* [Mamadou Elaphi ARAFA](https://codefirst.iut.uca.fr/git/mamadou_elaphi.arafa) +* [Augustin AFFOGNON](https://codefirst.iut.uca.fr/git/augustin.affognon) + + +## Support + +Contactez-moi à l'un des endroits suivants ! + +* Website at `https://codefirst.iut.uca.fr/victor_perez.ngounou` +* Email at ` + +## License + +[![License](https://codefirst.iut.uca.fr/sonar/api/project_badges/measure?project=BowlingScoreApp&metric=license&token=d89d41f6a247037395d41fe6f40f53a402943bd9)](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp) + +- **[MIT license](http://opensource.org/licenses/mit-license.php)** \ No newline at end of file