aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoic Guegan <manzerbredes@mailbox.org>2022-01-24 16:52:26 +0100
committerLoic Guegan <manzerbredes@mailbox.org>2022-01-24 16:52:26 +0100
commitbbbe18df2f07154d8923867c05850a6b148b1931 (patch)
treea6ace8bc20661c5ecad67554a1fd599feb0a5498
parente6e2c5a8bf5c99119799c9ac706c4428fec6b5aa (diff)
Update README.md
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6b3a8c2..a3d4557 100644
--- a/README.md
+++ b/README.md
@@ -27,5 +27,23 @@ Load PGN from string:
catch(...){
// Handle exceptions
}
+Various API calls:
+
+ pgn.HasTag("Round"); // Check if tag exists
+ try {
+ pgn.STRCheck(); // Perform a Seven Tag Roster check
+ }
+ catch(...){
+ // Handle exceptions
+ }
+ std::vector<std::string> tags=pgn.GetTagList(); // Get a list of tags
+ std::string tagValue=GetTagValue("Date"); // Get the value of a tag
+Access to moves:
+
+ pgnp::HalfMove *move=pgn.GetMoves(); // Get the tree of half moves
+ int length=move->GetLength(); // Get the number of half moves in the move MainLine
+ // Public members:
+ // move->variations contains variations of the current move
+ // move->isBlack boolean that says if current half move is for the black side
+ // Check pgnp.hpp for more infos for other field (comments, count, etc.)
-// TODO: How to use the PGN object with the parsed data \ No newline at end of file