From 9c47779a38e23bfa1ca334d22e86bdcdcaab79e9 Mon Sep 17 00:00:00 2001
From: JakeKantor <jacobmk8@gmail.com>
Date: Thu, 15 Feb 2024 21:03:06 -0500
Subject: [PATCH] Added Installation to README

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

diff --git a/README.md b/README.md
index ee846b5..be8bdce 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,41 @@ About the name:
 * pytorch >= 1.1.0
 * torchvision >= 0.3.0 
 
+# Installation Instructions
+
+## 1. Clone the Repository
+
+```bash
+git clone https://github.com/your-username/FaceX-Zoo.git
+cd FaceX-Zoo
+```
+
+## 2. Set Up Virtual Environment 
+
+```bash
+python -m venv face-env
+```
+
+Activate on Linux/MacOS:
+```bash
+source face-env/bin/activate
+```
+
+Activate on Windows:
+```bash
+face-env\Scripts\activate
+```
+## 3. Install Dependencies
+```bash
+pip install -r requirements.txt
+```
+## 4. Check Installation
+```bash
+python -c "import facex_zoo"
+```
+
+
+
 # Model Training  
 See [README.md](training_mode/README.md) in [training_mode](training_mode), currently support conventional training and [semi-siamese training](https://arxiv.org/abs/2007.08398).
 # Model Evaluation