From ee68b4025bf5c1e4639953bd3f12f64534c52104 Mon Sep 17 00:00:00 2001 From: Cosmin Ciocan Date: Fri, 12 Jan 2024 16:56:49 +0100 Subject: [PATCH] Add README.md instructions for developers --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index d7ff5b4..f82f00f 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ to own a GPU yourself. - [Usage](#usage) - [License](#license) - [Documentation](#documentation) +- [Contributing](#contributing) ## Main Features 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 [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 +``` +
[Go to Top](#table-of-contents)