From dfaf786c1a7702f83de53d18fc5248117abfebc2 Mon Sep 17 00:00:00 2001
From: Gene Pasquet <dev@etenil.net>
Date: Sun, 18 May 2025 09:53:38 +0100
Subject: Licensing etc.

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 41 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ba29bbc..ffe301a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,42 @@
-LISP GAME JAM 2025
-==================
+MACROKNIGHT
+===========
 
+This is a game written for the [Spring Lisp Game Jam 2025](https://itch.io/jam/spring-lisp-game-jam-2025).
+
+## Dependencies
+
+This is a python game written with [Hy](https://hylang.org) and [Pygame](https://pygame.org). It requires the following to be installed:
+
+- Python (3.9+)
+- SDL2
+
+## Quickstart
+
+To install the python dependencies and run the game, simply type:
+
+```
+make
+```
+
+## Manual installation
+
+*Recommended* Create a virtual environment for the dependencies. On Debian-based distributions, you will need the package `python3-venv`. Run the following:
+
+```
+python3 -m venv venv
+. venv/bin/activate
+pip install -r requirements.txt
+```
+
+Then run the game with the venv active:
+
+```
+hy src/macroknight/game.hy
+```
+
+
+## Credits
+
+- Code: Gene Pasquet
+- Levels: Owen Pasquet
+- Tile art: [Kenney](https://kenney.nl/assets/1-bit-pack)
-- 
cgit v1.2.3