From 91f78c6c56be3cc28d0cfaf05296ccc9e275975a Mon Sep 17 00:00:00 2001 From: Karma Riuk Date: Thu, 12 Jun 2025 17:34:47 +0200 Subject: [PATCH] updated readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a6bd48d..8ddc946 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,13 @@ A research-driven platform for evaluating deep learning models on automated code cd crab-webapp ``` +1. *(Optional)* **Create Python Environement** + + ```bash + python -m venv .venv + source .venv/bin/activate + ``` + 1. **Install** Python dependencies: ```bash @@ -37,7 +44,8 @@ A research-driven platform for evaluating deep learning models on automated code ### Environment Variables -Defaults are set in `src/utils/env_defaults.py` (port 45003, `data/` path, etc.) To override: +Defaults are set in `src/utils/env_defaults.py` (port 45003, `data/` path, etc.) and described in +the comments of `.env.example`. To override: ```bash cp .env.example .env