summaryrefslogtreecommitdiffstats
path: root/share/README.txt
blob: edd8a2b2bec7d79508f9ec1e0f54cd13a6dfd2a9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/******************************************************************************
 * Based on the game 'Mine', written in 1990 by				      *
 * Robert Donner & Curt Johnson at Duff Software.			      *
 *									      *
 * Check this: https://tcrf.net/Proto:Minesweeper_(Windows,_1990)	      *
 ******************************************************************************
 * mine-sweeper	Copyright (C) 2015	Alejandro Colomar Andrés	      *
 *									      *
 * This program is free software; you can redistribute it and/or modify	      *
 * it under the terms of the GNU General Public License as published by	      *
 * the Free Software Foundation, version 2.				      *
 *									      *
 * This program is distributed in the hope that it will be useful,	      *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of	      *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the	      *
 * GNU General Public License for more details.				      *
 *									      *
 * You should have received a copy of the GNU General Public License	      *
 * along with this program; if not, see the file COPYING, or write	      *
 * to the Free Software Foundation, Inc.				      *
 ******************************************************************************
 *	Disclaimer of Warranty.						      *
 *									      *
 * THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY	      *
 * APPLICABLE LAW.							      *
 *									      *
 * EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER *
 * PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER   *
 * EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED	      *
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.	      *
 *									      *
 * THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH   *
 * YOU.									      *
 *									      *
 * SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY   *
 * SERVICING, REPAIR OR CORRECTION.					      *
 ******************************************************************************/

	If you make a version, please tell me.
	I would like to see it. Thank you.

COMPILE:
	 - linux:
		$ make
	 - windows (MSYS):
		$ make OS=win

INSTALL:
	 - linux:
		# make install
	 - windows:
		run 'SETUP.cmd' as administrator

RUN:
	 - linux:
		$ mine-sweeper
				if it doesn't work:
		$ /usr/local/games/mine-sweeper
	 - windows:
		run 'bin/mine-sweeper.exe'

UNINSTALL:
	 - linux:
		# make uninstall
	 - windows:
		run 'UNINSTALL.cmd' as administrator


The program creates a folder '.mine-sweeper/' at $HOME (also in Windows).  It
is used by the program to store saved games.  If you remove the game, you
should delete that folder manually.


THE PROGRAM DOES:
	The typical minesweeper game.


MENU:
	When you run the program, it starts in a menu that has these branches:

	/*
	 * + Menu:
	 *	+ Continue:
	 *		- Start
	 *		+ Select map:
	 *			- New map
	 *			- Load map(File: "<file>")
	 *			- ..
	 *		+ Change difficulty:
	 *			- Beginner
	 *			- Intermediate
	 *			- Expert
	 *			+ Custom:
	 *				- Change rows: rows		(X)
	 *				- Change columns: cols		(X)
	 *				- Change proportion of mines: p	(0.XXXXXX)
	 *				- ..
	 *			- ..
	 *		- Change file name (File: "<file_name>")
	 *		- Hi scores
	 * N/A		x DEVEL:
	 * N/A			- Change seed (srand)
	 * N/A			- ..
	 *		- ..
	 *	- Disclaimer of warranty
	 *	- Terms and conditions
	 *	- Exit program
	 */


SYSTEM REQUIREMENTS:

	 * A terminal ¿?

To be continued...