aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 6b3a8c2bfd06c66ca4130ef04f646a306e488d21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
## PGNP: PGN Parser

PGNP is a Portable Game Notation (PGN) parser. More details about the
PGN specification can be found [here](https://www.chessclub.com/help/PGN-spec).

# How to use it ?
PGNP can be used as a shared library in your project.
You only need to include the header file and linking the .so file to your
executable.

# Example
Load PGN from file:

    pgnp::PGN pgn;
    try {
        pgn.FromFile("pgn.txt");
    }
    catch(...){
        // Handle exceptions
    }
Load PGN from string:

    pgnp::PGN pgn;
    try {
        pgn.FromString("YOUR PGN CONTENT HERE");
    }
    catch(...){
        // Handle exceptions
    }

// TODO: How to use the PGN object with the parsed data