From e1f0bf91646769117aa42fd2876d34022ef0c5c0 Mon Sep 17 00:00:00 2001
From: omagdy7 <omar.professional8777@gmail.com>
Date: Mon, 20 Mar 2023 15:07:49 +0200
Subject: Added a Descreption, Run, Todo in the READEME

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index e69de29..ec2bf1c 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,25 @@
+# Description
+- A very basic Pacman clone done in python using pygame library
+
+# Run
+- Open your favourite terminal
+
+```bash
+cd src
+python3 macpan.py
+```
+
+# TODO
+## Must DO
+- [X] Setup the basic player movement mechanics
+- [ ] Load the proper sprites for the map
+- [ ] Setup collision with walls
+- [ ] Replace the yellow circle with a pacman sprite
+- [ ] Setup the sprite animation for pacman
+- [ ] Add the ghosts in the game
+- [ ] Develop an algorithm to make the ghosts find pacman in the map(BFS, A*)
+- [ ] Setup the sprite animation for the ghosts
+
+## Optional
+- [ ] Setup a menu for the game
+- [ ] Setup a proper sfx/audio for the game
-- 
cgit v1.2.3