added readme

2020-07-02 12:07:27 +02:00
parent 3260df72cd
commit 727aa00fc6
2 changed files with 12 additions and 0 deletions
--- a/package.json
+++ b/package.json
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,12 @@
+# Python raycaster
+
+###### by Sem van der Hoeven
+
+This is a raycaster I made in python. it uses the `pygame` library for the graphics.
+
+## Installation
+Clone the repository by entering `git clone https://github.com/SemvdH/python-raycaster.git` into your command prompt. Then navigate to the folder using `cd python-raycaster`.
+
+If you don't have pygame installed yet, you can install it using `pip install pygame`.
+
+Now you can run the raycaster by entering `python raycaster.py`