Index

ncurses-minesweeper / f87f675

Terminal game of Minesweeper, implemented in C with ncurses.

Latest Commit

{#}TimeHashSubjectAuthor#(+)(-)GPG?
2918 Sep 2020 09:58f87f675Update README (again)Josh Stockin111G

Blob @ ncurses-minesweeper / README.md

text/plain2065 bytesdownload raw
1# ncurses Minesweeper
2
3Terminal game of Minesweeper, implemented in C with ncurses.
4
5## Game
6
7Minesweeper is a logic game where mines are hidden in a grid of squares. The
8object is to open all the safe squares in the shortest time possible. Use
9\<hjkl\> to move and \<SPACE\> to select. Read the Help page for more
10information.
11
12![Title screen](https://i.imgur.com/HRhl4B2.png)
13![Ready to start](https://i.imgur.com/HObmgcl.png)
14![Playing](https://i.imgur.com/7Wx2mbk.png)
15![Kaboom](https://i.imgur.com/T6bjZVK.png)
16![Finished game](https://i.imgur.com/8c6zKGl.png)
17
18## Installation
19
20Currently functional on all systems with an ncurses library. PDCurses may be
21dropped in and linked on Windows, although this hasn't been tested.
22
23Requirements: `build-essential libncurses-dev`
24
25Compiling and linking:
26```
27make compile build
28```
29
30Binary executable deposited at `bin/minesweeper`.
31
32**If you're contributing source code to this repository, install `clang-format
33clang-tidy` and use `make` to target the linter programs.** (`clang-format` is
34a bit finicky; make sure you're running version 10.0.0, or it will yell at you
35about unsupported configuration in `.clang-format`.)
36
37## Source file structure and program flow
38
39* Entry point at `src/main.c`
40* Rendering logic loop at `src/draw/draw.c`
41* Game logic handler at `src/game/game.c`
42* Game renderer at `src/draw/game.c`
43
44All header files correspond to a similarly named source file except
45`src/draw/pages.h` which encapsulates multiple sources in the same directory.
46
47# Copyright and Licensing
48
49This package is copyrighted by [Joshua 'joshuas3'
50Stockin](https://joshstock.in/) and licensed under the [MIT License](LICENSE).
51
52A form of the following should be present in each source or header file.
53
54```txt
55ncurses-minesweeper Copyright (c) 2020 Joshua 'joshuas3' Stockin
56<https://joshstock.in>
57<https://github.com/JoshuaS3/ncurses-minesweeper>
58This software is licensed under the MIT License.
59```
60
61<<https://joshstock.in>> | joshstockin@gmail.com | joshuas3#9641 |
62[LinkedIn](https://www.linkedin.com/in/joshstockin/)
63