README.md

skaak

Python Chess Library
Check it out »

Report Bug · Request Feature

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact

Getting Started

To get a local copy up and running follow these simple example steps:

1. Clone the repository onto your machine and navigate into the project folder

   $ git clone https://github.com/georgemunyoro/skaak && cd skaak

2. Create a virtual environment

   $ python3 -m venv venv && source ./venv/bin/activate

3. Install the required packages

   $ pip install -r ./requirements.txt

Installation

Skaak can be installed with the pip package manager. Simply install it and run pip install skaak.

Prerequisites

The application requires the following to be installed on your system in order to run:

• Python 3.8.6

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

NB: if you intend to add a feature or make changes that will go into the final product, you must create an issue on the project board, and comply to the contributing guidelines, if you are just messing around, or would like to build your own project on top of Pydgon, feel free to do as you please.

1. Fork the Project
2. Create your Branch

   $ git checkout -b branchName

3. Make your changes
4. Commit your Changes

   $ git commit -m 'Add some amazing feature or changes

5. Push to the Branch

   $ git push origin branchName

6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

George Munyoro - @george_munyoro

Project Link: https://github.com/georgemunyoro/skaak