From 62880a4a529116109475195fb356ef9d48a627d1 Mon Sep 17 00:00:00 2001
From: mcolonna <mcolonna@student.42perpignan.fr>
Date: Wed, 30 Jul 2025 18:09:23 +0200
Subject: [PATCH] add README.md

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b509a13
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# so\_long
+
+this is a little video-game i had to make for 42 school. it uses the MinilibX library.
+
+i spend way too much months on it but it's cool i think
+
+## compile and run
+
+this project only works on linux (it may work on macOS too but you will need to manually add the MinilibX library for macOS).
+
+1. in your terminal, run `make -v`.
+if you have a `command not found` error or equivalent, you will need to install `make`. on ubuntu / debian, run:
+```sh
+$ sudo apt install make
+```
+
+2. clone the repository and cd inside it:
+```sh
+$ git clone https://gitea.zaclys.com/frzysk/42_so_long
+$ cd 42_so_long
+```
+
+3. build the game:
+```sh
+$ make
+```
+
+4. run the game:
+```
+$ ./so_long
+```
+
+## play
+
+- you control snas.
+- use arrows, W/A/S/D or Z/Q/S/D to move.
+- get ketchup.
+- escape firsk.
+
+there is a counter of your moves. try to finish the game with the less moves possible :)