Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
# WinChess


<!-- winchess:badges:start -->
[![Build and test](https://github.com/binarylab2022-del/WinChess/actions/workflows/build.yml/badge.svg)](https://github.com/binarylab2022-del/WinChess/actions/workflows/build.yml)
[![Release](https://img.shields.io/github/v/release/binarylab2022-del/WinChess)](https://github.com/binarylab2022-del/WinChess/releases/latest)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Platform](https://img.shields.io/badge/platform-Windows%20x64-blue)](#requirements)
<!-- winchess:badges:end -->

<!-- winchess:status:start -->
> **Project status:** Early public release. The native regression suite, Windows
> build, UCI smoke tests, release packaging, and SHA-256 validation are
> automated. Broader gameplay, compatibility, and strength testing by external
> users is still needed.
<!-- winchess:status:end -->
WinChess is an open-source chess application for Windows. It combines a native C++ chess engine, a WPF desktop interface, and a UCI command-line host that can be loaded by compatible chess GUIs.

> **Project status:** early public release. The native core has a substantial regression suite, but playing strength and Windows packaging still need broader community testing.

## Main features

Expand Down Expand Up @@ -38,6 +51,18 @@ For the complete Windows application:

The native regression tests also build on Linux, WSL, and macOS with a C++20 compiler, CMake, and pthread support.

## Download

The latest Windows x64 release is available from the
[GitHub Releases page](https://github.com/binarylab2022-del/WinChess/releases/latest).

Download the following two files:

- `WinChess-0.1.0-win-x64.zip`
- `WinChess-0.1.0-win-x64.zip.sha256`

The ZIP contains the WPF application, the UCI host, the native chess-engine
library, license information, and SHA-256 checksums.
## Build on Windows

Open `ChessProject.slnx`, select `Release | x64`, and build the solution. The main outputs are:
Expand Down Expand Up @@ -96,12 +121,19 @@ The desktop application can launch a user-selected UCI executable. Only import e

Bug reports, reproducible test positions, performance measurements, documentation improvements, and focused pull requests are welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md) before submitting changes.

## Authors

- **Touil Ghassen** — Project lead, software architecture, and chess-engine development
- **BAZIZ Chafia** — Developer
- **BOUAKAZ Ahlem** — Developer

See [AUTHORS.md](AUTHORS.md) for detailed authorship and contribution information.
## License

The WinChess source code is licensed under the [MIT License](LICENSE).

The bundled Cburnett chess-piece SVG files are separately licensed under **CC BY-SA 3.0**. SharpVectors is a BSD-3-Clause dependency. See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) and [ChessGUI/Pieces/README.md](ChessGUI/Pieces/README.md).

## Credits

The UCI engine identifies the original author as **Ahlem Chafia**. The public repository is maintained through the BinaryLab GitHub account with contributions welcomed from the community.
WinChess is developed and maintained by the contributors listed in
[AUTHORS.md](AUTHORS.md). Community contributions are welcome.
Loading