notkshitij/nvcc
1
0
Fork 0
mirror of https://github.com/andreinechaev/nvcc4jupyter.git synced 2026-06-15 11:40:48 +05:30
Code Issues Packages Projects Releases Wiki Activity

Update contributing instructions

Browse Source
This commit is contained in:
Cosmin Ștefan Ciocan
2024-01-27 01:57:09 +00:00
parent 33801a3491
commit a3f4f31962
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -5
View File
@@ -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
@@ -88,13 +89,14 @@ The official documentation is hosted on [readthedocs](https://nvcc4jupyter.readt
## Contributing
Install the package with the development dependencies:
The recommended setup for development is using the devcontainer in GitHub
Codespaces or locally in VSCode.
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]
```
As a developer, make sure you install the pre-commit hook before commiting any changes:
```bash
pre-commit install
```