From a359219e33fdf3afb5ddfbb084563054a947b106 Mon Sep 17 00:00:00 2001
From: Loic Guegan <manzerbredes@mailbox.org>
Date: Sat, 12 Feb 2022 19:13:34 +0100
Subject: Create project

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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:
+![wxWidgets](examples/wxWidgets/demo.gif)
-- 
cgit v1.2.3