Debian Codegraph @

README

raw
1 pgn2web 0.4 - Converts PGN files to interactive web pages
2 =========================================================
3
4 0. Contents
5 -----------
6
7 0. Contents
8 1. Introduction
9 2. Installation
10 3. Usage
11 4. Acknowledgements
12 5. License Notice
13
14 1. Introduction
15 ---------------
16
17 pgn2web is *free* software for converting PGN files to webpages that allow you
18 to replay the game(s) within a web browser. This software is intended as a free
19 cross-platform replacement for existing non-free conversion programs.
20
21 This is only the fourth release, there may be many bugs but on the whole it
22 should be fairly usable. Please email any bug reports, comments, or suggestions
23 to [email protected]
24
25 2. Installation
26 ---------------
27
28 Linux
29 ~~~~~
30
31 Installation requires that you have the wxWidgets (formerly wxWindows) library
32 installed. Most distributions will have a ready made package for this.
33
34 The installation is fairly standard. Simply untar the archive, change
35 to the resulting directory, type make, switch to root and type make install.
36
37 Mac OS X
38 ~~~~~~~~
39
40 Simply open the disk image and copy the program to your application folder.
41
42 Windows
43 ~~~~~~~
44
45 It is recommended that if you have a previous version of pgn2web installed that
46 you uninstall it first.
47
48 The Windows version is distributed as a Microsoft Installer Package. If you are
49 running XP or have the Windows Installer software on your system then you can
50 simply run the MSI file to install. If you are not running XP and do not have
51 the Windows Installer on your system you will need to download it from the
52 Microsoft Website.
53
54 3. Usage
55 --------
56
57 As of version 0.4 the command line interface to pgn2web is only available on
58 Linux. Windows and Mac OS X users should skip this section.
59
60 The syntax for pgn2web is as follows:
61
62 pgn2web <options> <pgnfile> <htmlfile>
63
64 The options being:
65
66 [-c yes|no] - include a link to the pgn2web homepage
67 [-p <pieces>] - use the <pieces> pieceset
68 [-s frameset|linked|individual] - use the specified layout
69
70 Passing no parameters at all will simply launch the GUI version.
71
72 4. Acknowledgements
73 -------------------
74
75 Thanks to Simon Pittock of http://www.apexwebworks.co.uk for his help in
76 clearing up some javascript and CSS issues.
77
78 5. License Notice
79 -----------------
80
81 Copyright (C) 2004, 2005 William Hoggarth
82 <email: [email protected]>
83
84 This program is free software; you can redistribute it and/or modify
85 it under the terms of the GNU General Public License as published by
86 the Free Software Foundation; either version 2 of the License, or
87 (at your option) any later version.
88
89 This program is distributed in the hope that it will be useful,
90 but WITHOUT ANY WARRANTY; without even the implied warranty of
91 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
92 GNU General Public License for more details.
93
94 You should have received a copy of the GNU General Public License
95 along with this program; if not, write to the Free Software
96 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA