aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLoic Guegan <manzerbredes@mailbox.org>2022-01-25 11:10:34 +0100
committerLoic Guegan <manzerbredes@mailbox.org>2022-01-25 11:10:34 +0100
commitd4df0dac1d8d05bc260c666ede6f732d5d23a803 (patch)
tree66a9ccb9d367e295772c2e64563b6abeeea05781 /README.md
parent4f1d7c524744861ee9cd3052c2ec9e42e83a32ca (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 18 insertions, 8 deletions
diff --git a/README.md b/README.md
index 2a50b63..a479f1b 100644
--- a/README.md
+++ b/README.md
@@ -5,10 +5,13 @@ 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
+You only need to include `pgnp.hpp` and linking the .so file to your
executable.
# Example
+Somewhere at the beginning of the file:
+
+ #include "pgnp.hpp"
Load PGN from file:
pgnp::PGN pgn;
@@ -29,7 +32,7 @@ Load PGN from string:
}
Various API calls:
- pgn.HasTag("Round"); // Check if tag exists
+ bool hasRound=pgn.HasTag("Round"); // Check if tag exists
try {
pgn.STRCheck(); // Perform a Seven Tag Roster check
}
@@ -40,11 +43,18 @@ Various API calls:
std::string tagValue=GetTagValue("Date"); // Get the value of a tag
Access to moves:
- pgnp::HalfMove *move=new pgnp::HalfMove();
- pgn.GetMoves(move); // Get the tree of half moves (do not forget to call "delete move")
- int length=move->GetLength(); // Get the number of half moves in the move MainLine
+ pgnp::HalfMove *moves=new pgnp::HalfMove();
+ pgn.GetMoves(moves); // Get the tree of half moves (do not forget to call "delete move" later on)
+ int length=moves->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.)
+ // moves->variations contains variations of the current move
+ // moves->isBlack boolean that says if current half move is for the black side
+ // Check pgnp.hpp for more infos for the other fields (comments, count, etc.)
+
+# CMake Integration
+By using the `add_subdirectory()` on this repository you will be able to use the following cmake calls in you project:
+
+ include_directories(${PGNP_INCLUDE_DIR})
+ target_link_libraries(<YOUR_TARGET> pgnp)
+