Welcome to ChessPuzzlePecker 👋

ChessPuzzlePecker is a chess training tool built in C#. The repository includes the WinForms app and a the ChessSharp library, which I forked to create this application.

Install the package

This chapter is probably wrong currently. ---

• To install the package from Package Manager Console, run the following command:

  Install-Package ChessSharp
  

• To install the package from .NET CLI, run the following command:

  dotnet add package ChessSharp
  

• To install using the PackageReference, add the following XML node into your project file. For more information about PackageReference, see NuGet package reference format.

  <PackageReference Include="ChessSharp" Version="1.1.0" />

Repository structure

The repository consists of three folders:

• Documentation folder: This folder is generated by docFX. TODO: is this true?
• docs folder: This is the actual website (defaultly called _site) generated by docFX. It's rendered by GitHub pages in https://youssef1313.github.io/ChessSharp/. TODO: is this true?
• src folder: This folder contains the actual source code and contains these folders:
  • AwiUtils: SOme generally usable utilities that I use in many projects.
  • ChessSharp: The source code of the ChessSharp Library, originally from https://youssef1313.github.io/ChessSharp/. I've improved it and fixed some bugs, though.
  • ChessUI: The ChessPuzzlePecker app. It consumes the ChessSharp library.
  • ChessSharpWeb: an ASP.NET Core MVC project that consumes the library. Not completed, and not working currently.

Screenshot of the UI (WinForms) project

🤝 Contributing

Contributions, issues, bug reports, and feature requests are welcome!

Feel free to check the issues page.

Can you make ChessPuzzlePecker better ? Feel free to open a pull request.

Show your support

Give a ⭐️ if this project helped you!

Please note that this project is still under development, but it's working well!