Add README

master
En Yi 2018-07-23 18:10:38 +08:00
parent 364e124c2c
commit 64d34cbd15
1 changed files with 19 additions and 0 deletions

19
README.md 100644
View File

@ -0,0 +1,19 @@
# About
This is just a Sudoku program written in python using the PyQt5 library. It's supposed to be a learning experience
about the graphics system of PyQt. The goal(?) is to make it as animated as possible.
## Requirements
Requires `Python 3`, `PyQt5`, and `Numpy`.
Use the requirements.txt to install the dependencies.
## Running
Clone this repository and run the `main` file, once the dependecies are installed.
## In-Game Instruction
Mouse to select a cell. While a cell is selected, click on a number to fill the cell. X to cancel.
Keyboard can also be used.
Holding M while inputting a number will scribble on the cell instead, which is useful for making notes.
Have fun!