Add README.md instructions for developers

This commit is contained in:
Cosmin Ciocan
2024-01-12 16:56:49 +01:00
parent ef642e3480
commit ee68b4025b
+13
View File
@@ -29,6 +29,7 @@ to own a GPU yourself.
- [Usage](#usage) - [Usage](#usage)
- [License](#license) - [License](#license)
- [Documentation](#documentation) - [Documentation](#documentation)
- [Contributing](#contributing)
## Main Features ## Main Features
Here are just a few of the things that nvcc4jupyter does well: Here are just a few of the things that nvcc4jupyter does well:
@@ -75,6 +76,18 @@ The official documentation is hosted on [readthedocs](https://nvcc4jupyter.readt
## License ## License
[MIT](LICENSE) [MIT](LICENSE)
## Contributing
Install the package with the development dependencies:
```bash
pip install .[dev]
```
As a developer, make sure you install the pre-commit hook before commiting any changes:
```bash
pre-commit install
```
<hr> <hr>
[Go to Top](#table-of-contents) [Go to Top](#table-of-contents)