diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c15ccbd --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Syed + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a096d75 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# 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` + +## Installation +### Prerequisites +- Go 1.18+ installed + +### Steps +1. Clone this repository: + ```sh + git clone https://github.com/Toprun123/go-mines.git + cd minesweeper-terminal + ``` +2. Install dependencies: + ```sh + go get ./... + ``` +3. Build the project: + ```sh + go build -o minesweeper + ``` +4. Run the game: + ```sh + ./minesweeper + ``` + +## 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