aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLoic Guegan <manzerbredes@mailbox.org>2023-01-01 12:30:04 +0100
committerLoic Guegan <manzerbredes@mailbox.org>2023-01-01 12:30:04 +0100
commitbc82aad30420a11471f8951dcd99dd3f9739679f (patch)
tree12d7b203ca1fce54148eaf632c31f43836e49fdd /README.md
parent5607057ac33ce3b6933697134b20d7ef0b1a43be (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 21 insertions, 7 deletions
diff --git a/README.md b/README.md
index 0e7f664..b3038f9 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,27 @@
-# Open Chess &nbsp; [![Pipeline](https://gitlab.com/manzerbredes/ochess/badges/master/pipeline.svg)](https://gitlab.com/manzerbredes/ochess/pipelines) [![Pipeline](https://img.shields.io/badge/cmake-v3.10-blue)](https://cmake.org/download/) [![Pipeline](https://img.shields.io/badge/boost-v1.65-blue)](https://www.boost.org/) [![Pipeline](https://img.shields.io/badge/wxWidgets-v3.0.4-blue)](https://www.wxwidgets.org/)
+# Open Chess &nbsp; [![Pipeline](https://gitlab.com/manzerbredes/ochess/badges/master/pipeline.svg)](https://gitlab.com/manzerbredes/ochess/pipelines) [![Pipeline](https://img.shields.io/badge/cmake-v3.10-blue)](https://cmake.org/download/) [![Pipeline](https://img.shields.io/badge/wxWidgets-v3.0.4-blue)](https://www.wxwidgets.org/)
![Screenshot](tools/assets/icons/screenshot.jpg)
-## Requirements
- - CMake
- - wxWidgets
+## Features
+ - PGNs files (*.si4* files not yet but soon!)
+ - Handle heavy game files
+ - Live chess engine analysis with *UCI* compliant chess engines
+ - Intuitive game annotations
+ - Simple database management system
+
+## Installation
+Requires *CMake* and *wxWidgets*:
+
+ > git clone https://gitlab.com/manzerbredes/ochess
+ > cd ./ochess
+ > git submodule init
+ > git submodule update
+ > mkdir ./build && cd ./build
+ > cmake ../ && make
## Still ongoing
- - Fix memory leaks
- - Solve various bugs
- - Add support for various database formats such as .si4 (only PGN files for now)
+ - Add support for *.si4* file format
+ - Improving user experience
+ - Analyze and generate game reports
+ - Many more features...