Files
GoMines/README.md
Syed Daanish c36d278a31
Some checks failed
Go / build (push) Has been cancelled
Fix Github workflow and add screenshots
2025-10-03 11:52:19 +01:00

55 lines
1011 B
Markdown

# Minesweeper (Terminal Edition)
A terminal-based Minesweeper game written in Go, using the `tcell` library for handling terminal UI and events.
## Features
- Classic Minesweeper gameplay
- Intuitive keyboard controls
- Terminal-based UI
- Real-time updates with `tcell`
## Some screenshots
![image1](./images/1.png)
![image2](./images/2.png)
![image3](./images/3.png)
## Installation
### Prerequisites
- Go 1.18+ installed
### Steps
1. Clone this repository:
```sh
git clone https://github.com/Toprun123/go-mines.git
cd go-mines
```
2. Install dependencies:
```sh
go get ./...
```
3. Build the project:
```sh
go build -o go-mines
```
4. Run the game:
```sh
./go-mines
```
## Controls
- `Arrow Keys` - Move cursor
- `Enter` - Reveal cell
- `F` - Flag/Unflag cell
- `Q` - Quit game
Or Mouse Clicks (Left Click to Reveal, Right Click to Flag/Unflag)
## Contributing
Feel free to open issues or submit pull requests!
## Author
Syed - https://github.com/Toprun123