aboutsummaryrefslogtreecommitdiff
path: root/tools/doxygen/Libraries.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/doxygen/Libraries.md')
-rw-r--r--tools/doxygen/Libraries.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/tools/doxygen/Libraries.md b/tools/doxygen/Libraries.md
new file mode 100644
index 0000000..77a6bd0
--- /dev/null
+++ b/tools/doxygen/Libraries.md
@@ -0,0 +1,24 @@
+Internal Libraries
+====
+
+Ochess uses 5 internal libraries (excluding [wxWidgets](https://www.wxwidgets.org/)):
+- [cgeditor](https://gitlab.com/manzerbredes/cgeditor): A 2D chess game moves presenter/editor
+- [pgnp](https://gitlab.com/manzerbredes/pgnp): An efficient PGN parser
+- [chessarbiter](https://gitlab.com/manzerbredes/chessarbiter): A chess classical chess game arbiter for C++
+- [uciadapter](https://gitlab.com/manzerbredes/uciadapter): A cross platform utility to interact with UCI chess engines
+- [chess-move-interface](https://gitlab.com/manzerbredes/chess-move-interface): A chess half move interface for libraries interoperability
+
+### CGEditor
+It is only used in EditorCanvas.
+
+### PGNP
+It is only used in PGNGameBase.
+
+### ChessArbiter
+Mostly used in Game and HalfMove.
+
+### UCIAdapter
+Used in various engine related areas such as MainWindow, EngineTab and LiveEngineDialog.
+
+### Chess-Move-Interface
+Used in various region of OChess such as PGNGameBase and HalfMove. \ No newline at end of file