From: Georgios Atheridis <atheridis@tutamail.com>
Date: Thu, 14 Jul 2022 09:19:14 +0000 (+0300)
Subject: added readme
X-Git-Url: https://git.atheridis.org/?a=commitdiff_plain;h=refs%2Fheads%2Fmaster;p=personal%2Fpebbling-a-chessboard.git

added readme
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..159e37b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+<h1 align="center">Pebbling a Chessboard</h1>
+
+<p align="center">
+    <img width="600"
+        alt="Pebbling a Chessboard"
+        src="https://i.imgur.com/nxonTZ8.png">
+</p>
+
+## Description
+
+Based off of this [paper](https://mathweb.ucsd.edu/~ronspubs/95_03_pebbling.pdf)
+and this [youtube video by numberphile](https://www.youtube.com/watch?v=lFQGSGsXbXE).
+
+It is an impossible puzzle game that's supposed to be played on an infinite chessboard.
+Three pebbles are positioned in the bottom left, at positions (0, 0), (0, 1), and (1, 0).
+You are allowed to remove a pebble by placing two other pebbles; one to the top
+and one to the right of the pebble which is to be removed.
+The objective is to have no pebbles at any of the starting positions (0, 0), (0, 1), and (1, 0).
+
+
+## Installation
+
+To install the latest version just type `$ pip install git+https://github.com/atheridis/pebbling-a-chessboard.git`
+in your terminal. To run the program type `$ pebble-chessboard`.
+
+You may also clone this repository and install it from there.
+```
+$ git clone https://github.com/atheridis/pebbling-a-chessboard.git
+$ cd pebbling-a-chessboard
+$ pip install .
+```
+
+
+## OLD PROJECT
+
+This is one of many of my older projects which I never used git with.
+I have decided to turn it into a package and upload it to github.