Skip to content
This repository has been archived by the owner on Nov 7, 2021. It is now read-only.

killian-mahe/sudoku-csp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 

Repository files navigation


Sudoku CSP

A Python sudoku solver built with Qt.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

The goal of this project is to build an application to solve a user defined sudoku problem using CSP (Constraint Satisfaction Problems).

Built With

Getting Started

This project is based on Python. No framework is needed, but you must install the PySide6 package. We strongly suggest your to create a virtual environment to create the app environment. You can also use the Dockerfile to use with Docker.

Installation

Before clonning the repository, you should create a new virtual environment (using venv for exemple).

  1. Clone the project
    git clone https://github.com/killian-mahe/sudoku-csp.git
  2. Install virtual environment
    cd sudoku-csp && python3 -m venv env
  3. Activate the new environment
    source env/bin/activate
  4. Install required packages
    pip3 install -r requirements.txt

Use

  1. Start the project
    python sudoku_csp

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.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Contact

Killian Mahé - @killian-mahe - [email protected]

Project Link: https://github.com/killian-mahe/sudoku-csp

Acknowledgements