diff --git a/README.md b/README.md index 5705e7c..d721353 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,67 @@ -# Minesweeper +
+ logo +

Minesweeper

+
-## Docker +## Table of content + +- [Description](#description) +- [Techno used](#techno-used) +- [Installation](#installation) + - [Local](#local) + - [Docker](#docker) +- [Credits](#credits) + +## Description + +Minesweeper is a game where the player has to clear a minefield without detonating any mine. The game is won when all the cells without a mine are revealed. The game is lost when a mine is revealed. + +
+ game + game +
+ +## Techno used + + + +## Installation + +### Local + +- Clone the repository + + ```bash + git clone https://www.github.com/KeunotorCagoule/minesweeper.git + ``` + +- Install the dependencies + + ```bash + npm install + ``` + +- Run the server as _development_ + + ```bash + npm start + ``` + +- Run the server as _production_ + + ```bash + npm run build + npm i -g serve + serve build + ``` + +### Docker - Build the image @@ -13,3 +74,8 @@ ```bash docker run --name minesweeper -dp 3000:3000 minesweeper ``` + +# Credits + +- [KeunotorCagoule](https://www.github.com/KeunotorCagoule) +- [UnEpicier](https://www.github.com/UnEpicier) diff --git a/assets/game.png b/assets/game.png new file mode 100644 index 0000000..93ec503 Binary files /dev/null and b/assets/game.png differ diff --git a/assets/leaderboard.png b/assets/leaderboard.png new file mode 100644 index 0000000..0b0c880 Binary files /dev/null and b/assets/leaderboard.png differ diff --git a/assets/logo_circle.png b/assets/logo_circle.png new file mode 100644 index 0000000..8c99025 Binary files /dev/null and b/assets/logo_circle.png differ