root/05/release-0.5g/doc/readme.txt

Revision 1, 4.7 kB (checked in by ugz, 5 years ago)

Initial repository layout

Line 
1Kombilo 0.5 - a go database program
2
3This program was written by Ulrich Goertz (u@g0ertz.de), and is published
4under the GNU General Public License.
5
6What follows is a brief description of the features of Kombilo.
7More detailed information can be found in the tutorial, either at
8http://www.g0ertz.de/kombilo/tutorial.html or from Kombilo's
9help menu.
10
11---------------------------------------------------------------------------
12
13Acknowledgments:
14
15I am very grateful to all the people who sent me their comments and
16suggestions for improvements.
17
18Disclaimer:
19
20I have thoroughly tested Kombilo on a Linux box, and on a Windows 2000
21system. There are no bugs that I know of, but probably some bugs exist
22nevertheless. So let me state clearly that this program comes WITHOUT
23ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
24FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
25for more details.
26
27Where to get Kombilo:
28
29- You can download the Kombilo distribution (as a .exe installer for Windows,
30  as a .tar.gz for Linux/Unix or as a .zip file for Windows/Macintosh) from
31
32    http://www.g0ertz.de/kombilo/
33
34  (NB: The 0 in g0ertz is a zero!)
35
36  On that page you can also find more information about Kombilo, including
37  a brief tutorial with some screenshots.
38
39Give it a try and please send me your feedback! Any comments, and especially
40bug reports are welcome.
41
42------------------------------------------------------------------------------
43
44Kombilo is a go database program. Its main purpose is to search for
45games in which a given pattern or position occurs. You can also
46search for other criteria (like time period, players, events).
47
48Version 0.5 of Kombilo has now been released. A few bugs in version 0.5
49have been fixed, and several features have been added (see below).
50
51The main features of Kombilo are:
52
53* It is free software, published under the GNU General Public License:
54  you may download and use it for free, redistribute it (and even
55  modify it, if you release the changes under the same license).
56
57* It works on most current operating systems: The main part of Kombilo
58  is written in Python, a programming language which is available for
59  most platforms, including Unix/Linux, Windows, Macintosh ...
60  For Windows, a comfortable installer is available, which makes it
61  unnecessary to install Python.
62
63* The main purpose of the program is to search for patterns in SGF files,
64  like
65
66  |----------
67  |..........
68  |..........
69  |...X.X....
70  |..X.......    (A)
71  |..XO......
72  |..OO......
73  |..........
74
75  in the corner, or
76
77  ......
78  ..XO..         
79  ..OX..
80  ......
81
82  anywhere on the board.
83
84  Of course, you don't have to enter ASCII diagrams, but there is a
85  comfortable graphical user interface :-)
86
87  The program produces a list of all games in which that pattern
88  occurs. You can look at the games with the included SGF editor.
89
90  Furthermore, Kombilo can display all the continuations that were
91  played in the search diagram. This makes it particularly easy to
92  study joseki and fuseki lines.
93
94* The database is built from game records in SGF format. The
95  program does not come with any games included. But since there
96  are many sources for games in SGF format, this should be no
97  problem.
98
99  One possibility is to download game collections like the
100  collection of games from Cho Chikun made available by Jan van
101  Rongen, or the title games offered by Martin Mueller (see
102  http://www.g0ertz.de/go/ for links)
103 
104  On the other hand, there are commercial game collections.
105  Let me particularly recommend the GoGoD database compiled
106  by John Fairbairn and T Mark Hall, which includes more than
107  13.500 games, and is reasonably priced. I use it myself and
108  am very satisfied with it.
109
110* Speed:
111  The algorithm that is used is more or less straightforward.
112  Nevertheless, for the moment it seems to be good enough. See
113  the tutorial for a more detailed description. (If you have ideas
114  how to speed things up, I'm certainly interested in hearing
115  them ...)
116
117  Some samples, with the GoGoD database consisting of 13841
118  games, on my laptop with a PentiumIII mobile processor with
119  800MHz, and Windows 2000:
120
121  Pattern:      empty   (A) as   (B) as   low chin.
122                board   above    below    fuseki
123
124                3sec     2sec     5sec     2sec
125
126  Here pattern (B) is
127 
128      XO
129      OX
130
131  which produces a *lot* of matches (137051 hits, to be precise).
132
133* The name 'Kombilo' is the Esperanto word for comb, and since
134  'going through the game records with a fine-toothed comb'
135  is a suitable description of what the program does, it seemed
136  quite fitting. I hope that it's also easy to remember.
137  Pronunciation: 'i' as 'ee' in see, and the stress is on the 'i'.
138
139
Note: See TracBrowser for help on using the browser.