Skip to content

Commit

Permalink
Update contributing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
cosminc98 committed Jan 27, 2024
1 parent 33801a3 commit a3f4f31
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Here are just a few of the things that nvcc4jupyter does well:

- [Easily run CUDA C++ code](https://nvcc4jupyter.readthedocs.io/en/latest/usage.html#hello-world)
- [Profile your code with NVIDIA Nsight Compute](https://nvcc4jupyter.readthedocs.io/en/latest/usage.html#profiling)
- [Compile your code with external libraries (e.g. OpenCV)](https://nvcc4jupyter.readthedocs.io/en/latest/notebooks.html#compiling-with-external-libraries)
- [Share code between different programs in the same notebook / split your code into multiple files for improved readability](https://nvcc4jupyter.readthedocs.io/en/latest/usage.html#groups)

## Install
Expand Down Expand Up @@ -88,13 +89,14 @@ The official documentation is hosted on [readthedocs](https://nvcc4jupyter.readt

## Contributing

Install the package with the development dependencies:
```bash
pip install .[dev]
```
The recommended setup for development is using the devcontainer in GitHub
Codespaces or locally in VSCode.

As a developer, make sure you install the pre-commit hook before commiting any changes:
If not using the devcontainer you need to install the package with the
development dependencies and install the pre-commit hook before commiting any
changes:
```bash
pip install .[dev]
pre-commit install
```

Expand Down

0 comments on commit a3f4f31

Please sign in to comment.