aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index fdbac72..2b2772c 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,21 @@
[![license](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
# cgeditor: Chess Game Editor
-cgeditor is a dependency-free chess game editor library written in C++. It can be used with any library that provides 2D canvas drawing and mouse inputs features.
+cgeditor is a dependency-free chess game editor library written in C++. It can be used with any library that provides 2D canvas drawing and mouse/keyboard events.
# Features
-- Show move,move number, variations, NAGs, comments etc.
-- *Delete*, *Promote* and *Set as main line* features
+- Show move, move number, variations, NAGs, comments etc.
+- *Delete*, *Promote* and *Set as main line* menu entries
- Handle pieces icons
- Its graphical appareance is entirely customizable
# Architecture
-To run cgeditor you need to extend 2 classes:
+To run cgeditor 2 classes need to be extended:
- CGEditor (To draw and handle events)
- CGEHalfMove (The data structure displayed by the editor)
+See example for more informations.
+
# Example
An example based on *wxWidgets* is available in the `examples/` folder:
![wxWidgets](examples/wxWidgets/demo.gif)