Skip to content

Commit

Permalink
clarified developer instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
morbult committed Jan 28, 2025
1 parent be789ba commit 203538f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ When submitting PR's please take into account:

## Developer Instructions

Clone the repository, then install the development dependencies (we recommend using a virtual environment):
Clone the repository with submodules, make sure you have a C compiler installed, then install the development dependencies (we recommend using a virtual environment):

```bash
python -m venv .venv # create virtual environment in .venv
source .venv/bin/activate # activate virtual environment
source .venv/bin/activate # activate virtual environment (POSIX)
.venv/Scripts/activate.bat # activate virtual environment (Windows)
pip install --requirement requirements.txt # install development dependencies (includes asammdf in editable mode)
```

Expand Down

0 comments on commit 203538f

Please sign in to comment.