Skip to content

Commit 37a7507

Browse files
committed
Add description to README
1 parent e42411f commit 37a7507

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
11
# PGN2ABK
2-
Fast generator of chess openings book with support for Arena's book format (ABK).
2+
This is the simple tool to generate ABK (Arena's book format) files using a collection of games saved in the PGN file. There are several sources of PGN files, my favorite one is https://database.lichess.org/. It takes about 30 minutes to parse 190 GB file on normal HDD.
3+
4+
# Usage
5+
6+
```
7+
-i, --input Required. PGN input file to process.
8+
-o, --output Required. ABK output file.
9+
-p, --plies (Default: 2147483647) Maximal number of plies to parse.
10+
-e, --elo Minimal average ELO of players to parse the game.
11+
-t, --time Minimal initial game time to parse the game.
12+
-m, --multithreading Enable support for multithreading.
13+
--help Display this help screen.
14+
--version Display version information.
15+
```
16+
17+
# Example
18+
19+
Input: `-i D:\DB\lichess_db_standard_rated_2013-01.pgn -o C:\Users\Pawel\Desktop\generated.abk -p 20 -m`
20+
21+
Output:
22+
![Output](https://i.imgur.com/J4FcrwN.png)

0 commit comments

Comments
 (0)