Proper file header and introductory commentary for chess-pgn.el.

1 files changed, 53 insertions, 2 deletions

diff --git a/chess-pgn.el b/chess-pgn.el
index da1aa62..5233d7b 100644
--- a/chess-pgn.el
+++ b/chess-pgn.el
@@ -1,7 +1,58 @@
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;; chess-pgn.el --- Convert a chess game to/from Portable Game Notation (PGN)
+
+;; Copyright (C) 2002, 2004, 2008, 2014  Free Software Foundation, Inc.
+
+;; Author: John Wiegley <johnw@gnu.org>
+;; Maintainer: Mario Lang <mlang@delysid.org>
+;; Keywords: files, games
+
+;; 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.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; Portable Game Notation (PGN) is a plain text computer-processible format for
+;; recording chess games (both the moves and related data).
+;;
+;; Here is a sample game in PGN format:
+;;
+;; [Event "F/S Return Match"]
+;; [Site "Belgrade, Serbia Yugoslavia|JUG"]
+;; [Date "1992.11.04"]
+;; [Round "29"]
+;; [White "Fischer, Robert J."]
+;; [Black "Spassky, Boris V."]
+;; [Result "1/2-1/2"]
+;;
+;; 1. e4 e5 2. Nf3 Nc6 3. Bb5 a6 {This opening is called the Ruy Lopez.}
+;; 4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8  10. d4 Nbd7
+;; 11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5
+;; Nxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6
+;; 23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5
+;; hxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5
+;; 35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6
+;; Nf2 42. g4 Bd3 43. Re6 1/2-1/2
 ;;
-;; Convert a chess game to/from PGN notation
+;; This module provides functions for converting to/from PGN format:
 ;;
+;;    chess-game-to-pgn
+;;    chess-pgn-to-game
+;;
+;; and a mode for viewing/editing PGN files:
+;;
+;;    chess-pgn-mode
+
+;;; Code:
 
 (require 'chess-algebraic)
 (require 'chess-fen)