Skip to content

Improve development setup documentation with optional Windows instruc… #387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pip-install-godofcoding wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve development setup documentation with optional Windows instruc… #387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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```
Expand Down