From bb4476352714c9b1215a84103f7b6dcafd075108 Mon Sep 17 00:00:00 2001 From: Jaya Surya Thotapalli <37530409+JayaSuryaT@users.noreply.github.com> Date: Thu, 16 Dec 2021 21:08:30 +0530 Subject: [PATCH] Update readme (#20) --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0c1a841..40ed41f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ This is a [Minesweeper](https://en.wikipedia.org/wiki/Minesweeper_(video_game))- The objective of this game is to clear a rectangular board containing hidden "mines" or bombs without detonating any of them, with help from clues about the number of neighboring mines in each cell. +## Demo +| Dark mode | Light mode | +| -- | -- | +| Using Views - Light theme|Using Views - Dark theme| + + ## Features : * Zoomable and Panabel minefield * Safe first click - The first cell is never a mine as the minefield is generated around the first click @@ -17,19 +23,11 @@ The objective of this game is to clear a rectangular board containing hidden "mi * Long press an unrevealed cell to flag/unflag it * Tap an already revealed cell to expose potentially solved cells -## Demo - - -| Dark mode | Light mode | -| -- | -- | -| Using Views - Light theme|Using Views - Dark theme| - - ## Package Structure : ``` com.jayasuryat.minesweeperjc -├── 📂 app/ # App layer +├── 📂 app/ # App module │ ├── presentation/ # Navigation & Screens │ ├── theme/ # Theming │ └── MinesweeperApp.kt @@ -42,6 +40,8 @@ com.jayasuryat.minesweeperjc │ ├── state/ # Stateful grid and utils │ └── util/ │ +├── 📂 minesweeper-engine-debug/ # Module for debug utils related to minesweeper-engine +│ ├── 📂 minesweeper-ui/ # Module for all of the UI components of the mine grid │ └── composable/ │ ├── action/ # Action listeners for Minefield interaction actions @@ -60,8 +60,6 @@ com.jayasuryat.minesweeperjc │ ├── 📂 ui-difficulty-selection/ # Module for difficulty selection screen │ -├── 📂 minesweeper-engine-debug/ # Module for debug utils related to minesweeper-engine -│ └── 📂 util/ # Module for common utilities ``` @@ -73,9 +71,9 @@ com.jayasuryat.minesweeperjc All the SFX used in this project are sourced from freesound.org and are licensed under the Creative Commons 0 License. -* [Cell poping sound](https://freesound.org/people/onikage22/sounds/240566/) by [onikage22](https://freesound.org/people/onikage22/) * [Cell flagging sound](https://freesound.org/people/plasterbrain/sounds/237422/) by [plasterbrain](https://freesound.org/people/plasterbrain/) * [Cell unflagging sound](https://freesound.org/people/plasterbrain/sounds/423168/) by [plasterbrain](https://freesound.org/people/plasterbrain/) +* [Cell poping sound](https://freesound.org/people/onikage22/sounds/240566/) by [onikage22](https://freesound.org/people/onikage22/)