From 8a12f4d73f864d919642745c0dba9916b9a1c460 Mon Sep 17 00:00:00 2001
From: Nabil Ould Hamou <ouldhamounabil@gmail.com>
Date: Thu, 19 Dec 2024 12:24:52 +0100
Subject: [PATCH] Initial Commit

---
 .gitignore           |  1 +
 README.md            | 36 ++++++++++++++++++++++++++++++++++--
 main.py              |  0
 pip-dependencies.txt |  1 +
 4 files changed, 36 insertions(+), 2 deletions(-)
 create mode 100644 .gitignore
 create mode 100644 main.py
 create mode 100644 pip-dependencies.txt

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0cafc1c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.venv/
\ No newline at end of file
diff --git a/README.md b/README.md
index 1a0ef71..1f0e1b5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,34 @@
-# SignsDetectionAI
-AI project for my classes
+<h1 align="center">Signs Detection AI</h1>
+
+AI project for the Introduction to AI course at Université de Tours for the ISA Masters.
+
+## Requirements
+
+- Python 3.12
+
+## Installation
+
+Start by creating a virtual environment (Optional)
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+Install the dependencies
+```bash
+pip install -r pip-dependencies.txt
+```
+## Running the project
+
+Run the project
+```bash
+python main.py
+```
+
+## Testing
+
+## Documentation
+
+## Authors
+- Nabil Ould Hamou -  [@NabilOuldHamou](https://github.com/NabilOuldHamou)
+- Yanis Bouarfa - [@Yanax373](https://github.com/Yanax373)
\ No newline at end of file
diff --git a/main.py b/main.py
new file mode 100644
index 0000000..e69de29
diff --git a/pip-dependencies.txt b/pip-dependencies.txt
new file mode 100644
index 0000000..483931f
--- /dev/null
+++ b/pip-dependencies.txt
@@ -0,0 +1 @@
+opencv-python pytorch tensorflow numpy pandas matplotlib
\ No newline at end of file