diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f6b93e9 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# cgeditor: Chess Game Editor +cgeditor is a dependency-free chess game editor written in C++. It can be used with any library that provides 2D canvas drawing and mouse inputs features. + +# Features +- Show move,move number, variations, comments etc. +- *Delete*, *Promote* and *Set as main line* features +- Handle pieces icons +- Its graphical appareance is entirely customizable + +# Architecture +To run cgeditor you need to extend 2 classes: +- CGEditor (To draw and handle events) +- CGEHalfMove (The data structure displayed by the editor) + +# Example +An example based on *wxWidgets* is available in the `examples/` folder: + |