Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yinchi committed May 5, 2024
1 parent 880151f commit 4cf04fe
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,34 @@

## Developer Setup

**VSCode and WSL2 (for Windows users)**

It is recommended to work on this project using Visual Studio Code with WSL2, which provides a
Linux environment on Windows. See
[this tutorial](https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-vscode) on
how to set up VSCode and WSL2.

**Cloning the repository**

```bash
git clone https://github.com/yinchi/histopath-bim-des.git
cd histopath-bim-des

# Open the newly cloned repo in VS Code
code .
```

**Installing the project and its dependencies**

This project uses the [Poetry](https://python-poetry.org/) package manager.
To set up the project on your local computer, run:

```bash
# Installs poetry system-wide
sudo apt install python3-poetry
# optional
poetry config virtualenvs.in-project true

poetry install
```

Expand Down

0 comments on commit 4cf04fe

Please sign in to comment.