From 000c2ff6ac655d04ab09d9d925fda7cea404a354 Mon Sep 17 00:00:00 2001 From: Madhura R Hegde Date: Sun, 21 Dec 2025 13:25:53 +0530 Subject: [PATCH] Improve development setup documentation with optional Windows instructions Hi, I noticed that the development setup instructions included Linux/macOS-specific virtual environment activation steps. This PR adds a small, optional Windows-specific section with equivalent steps for creating and activating a virtual environment, while keeping the existing instructions unchanged. A short note is included to clarify that support may vary and that WSL can be used if needed. Please let me know if any changes or adjustments are required. Thank you for maintaining this project. --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5b5c9ff9a..984e2a962 100644 --- a/README.md +++ b/README.md @@ -35,23 +35,35 @@ If you are interested in contributing to EvalAI-CLI, follow our [contribution gu 3. Create a virtual environment + **Linux / macOS** + ```bash cd evalai-cli virtualenv -p python3 venv source venv/bin/activate ``` + **Windows (Optional)** + + ```bat + cd evalai-cli + python -m venv venv + venv\Scripts\activate + ``` + + Note: Official support may vary depending on the environment. + If you encounter issues on Windows, consider using WSL or a Linux-based environment. + 4. Install the package locally ```bash pip install -e . ``` - + 5. Change the evalai-cli host to make request to local EvalAI server running on `http://localhost:8000` by running: ```bash evalai host -sh http://localhost:8000 - ``` 6. Login to cli using the command ``` evalai login```