From a910dd5c864bc97346b36a025bb50091d7fbdf0c Mon Sep 17 00:00:00 2001 From: dawidg81 Date: Thu, 29 Jan 2026 14:41:37 +0100 Subject: Updated documentation --- docs/docs/index.md | 19 +++++++++++++++++++ docs/mkdocs.yml | 3 +++ 2 files changed, 22 insertions(+) create mode 100644 docs/docs/index.md create mode 100644 docs/mkdocs.yml (limited to 'docs') diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 0000000..862dd7e --- /dev/null +++ b/docs/docs/index.md @@ -0,0 +1,19 @@ +# minesweeper + +A reimplementation of minesweeper game in C++ in terminal. + +## Concept + +There are going to be 3 difficulties and one additional option where user can determine plot size and amount of mines by himself. + +Game commands are going to be read from normal std::cin input method. The project is not going to use curses, ncurses or lncurses libraries for now. + +Plot is going to be displayed (printed) on the upper left side of the screen, eventually with colors. Here are planned symbols of in-game elements: + +`#` - unrevealed tile. + +`.` - revealed tile (no mines around). + +`X` - (red color) bomb. + +Colorful numbers from `1` (1 mine around the revealed tile) to (maximum) `8` (8 mines around the revealed tile) - numbers saying how much mines are around it. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..95e27b0 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,3 @@ +site_name: minesweeper +theme: + name: material \ No newline at end of file -- cgit v1.2.3