summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMario Lang <mlang@delysid.org>2014-05-20 04:18:12 +0200
committerMario Lang <mlang@delysid.org>2014-05-20 04:18:12 +0200
commit056edda4a3c5fbf015013e0524fb7399999d8d40 (patch)
treea89c8fc41052e2196b92a5e93660488e70407ad8
parent8f0f2044b5445722aff29a0c58461a794564f13a (diff)
Upgrade to GPLv3 and make the Commentary section more useful.
-rw-r--r--chess.el56
1 files changed, 36 insertions, 20 deletions
diff --git a/chess.el b/chess.el
index c97762d..2d53189 100644
--- a/chess.el
+++ b/chess.el
@@ -12,39 +12,55 @@
;; URL: https://github.com/jwiegley/emacs-chess/
;; Compatibility: Emacs24
-;; This file is not part of GNU Emacs.
+;; 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, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; 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.
-;; This 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; either version 2, or (at your option) any later
-;; version.
-;;
-;; This 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 GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-;; MA 02111-1307, USA.
+;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Welcome to Emacs Chess, a chess playing module for GNU Emacs.
;;
-;; Type `M-x chess', and play chess against the default engine module.
-;; Type `C-u M-x chess' to select a specific engine.
+;; Type `M-x chess', and play chess against one of the default engine modules.
;;
-;; You can play against various external chess computer programs.
-;; There is also an Emacs based chess computer module which does not require
-;; any external programs. However, the internal AI is not very strong.
+;; Type `C-u M-x chess' to select a specific engine.
+;; You can play against various external chess computer programs, like
+;; crafty, fruit, glaurung, gnuchess, phalanx, sjeng and stockfish.
+;; There is also an Emacs based chess computer module (ai) which does not
+;; require any external programs. However, the internal AI is not very strong.
;;
;; To play on one of the internet chess servers, type `M-x chess-ics'.
;;
+;; If you'd like to view or edit Portable Game Notation (PGN) files,
+;; `chess-pgn-mode' provides a text-mode derived mode which can display the
+;; chess position at point.
+;;
+;; If you are new to Chess, `M-x chess-tutorial' provides a simple knight
+;; movement exercise to get you started, and `M-x chess-puzzle' can be used
+;; to solve puzzle collections.
+;;
+;; There are some different types of chessboard display modules available.
+;; * A simple character based display (chess-plain).
+;; * A more verbose ASCII chessboard (chess-ics1).
+;; * A graphical chessboard display which uses images (chess-images).
+;;
+;; The variable `chess-default-display' controls which display modules
+;; are tried when a chessboard should be displayed. By default, chess-images
+;; is tried first. If Emacs is not running in a graphical environment,
+;; chess-ics1 is used instead. To enable the chess-plain display module,
+;; customize `chess-default-display' accordingly.
+;;
;; Once this is working, the next thing to do is to customize
;; `chess-default-modules'. This is a list of functionality modules used
-;; by chess.el to provide its functionality. You can enable or
+;; by chess.el to provide additional functionality. You can enable or
;; disable modules so that Emacs Chess better suites your tastes.
;; Those modules in turn often have configuration variables, and
;; appropriate documentation at the top of the related file.