From 64d34cbd154d8c9ec4c2a7aead13f4963f61fd0c Mon Sep 17 00:00:00 2001 From: En Yi Date: Mon, 23 Jul 2018 18:10:38 +0800 Subject: [PATCH] Add README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a54a04 --- /dev/null +++ b/README.md @@ -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!