diff --git a/README.md b/README.md index e69de29..52a61af 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,50 @@ +# 🩺 OSCE Feedback Evaluator + +This tool automates the feedback process for clinical exams. Just point it at a directory of files and let it do the heavy lifting. + +--- + +## 🚀 Getting Started + +Follow these steps to get the pipeline running on your machine: + +### 1. Setup the Environment +First, let's keep your system clean by using a virtual environment. + +```bash +# Create the environment +python3 -m venv venv + +# Activate it +source venv/bin/activate +# (Windows users: .\venv\Scripts\activate) + + +### 2. Get the Code + +Pull the latest changes from the repository: +git pull https://github.com/Shahin-rmz/OSCE-Feedback-Evaluator.git + +``` + +### 3. Install Dependencies + +Make sure you are in the root directory where requirements.txt is located: +Bash + +```bash +pip install -r requirements.txt +``` + +### 4. Run the Pipeline + +Navigate to the pipeline folder and start the script: + +```bash +cd pipeline +python3 osce_pipeline.py +``` + +### 5. Process your Data + +When prompted, paste the path of the directory containing the files the app should work on.