Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #37

Merged
merged 5 commits into from
Jan 12, 2024
Merged

Update README.md #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e6f045d
Update README.md
gmarkall Jan 9, 2024
8723109
Fix repo name in CONTRIBUTING.md.
bdice Jan 12, 2024
45c68f4
Use public index for wheels.
bdice Jan 12, 2024
0bb6cd2
Merge branch 'main' into update-readme
bdice Jan 12, 2024
92e0e43
Use original image link now it is fixed
gmarkall Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Contributing to nvjitlink
# Contributing to pynvjitlink

If you are interested in contributing to nvjitlink, your contributions will fall
If you are interested in contributing to pynvjitlink, your contributions will fall
into three categories:
1. You want to report a bug, feature request, or documentation issue
- File an [issue](https://github.com/rapidsai/nvjitlink/issues/new/choose)
- File an [issue](https://github.com/rapidsai/pynvjitlink/issues/new/choose)
describing what you encountered or what you want to see changed.
- The RAPIDS team will evaluate the issues and triage them, scheduling
them for a release. If you believe the issue needs priority attention
Expand All @@ -22,13 +22,13 @@ into three categories:

### Your first issue

1. Read the project's [README.md](https://github.com/rapidsai/nvjitlink/blob/main/README.md)
1. Read the project's [README.md](https://github.com/rapidsai/pynvjitlink/blob/main/README.md)
to learn how to setup the development environment
2. Find an issue to work on. The best way is to look for the [good first issue](https://github.com/rapidsai/nvjitlink/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
or [help wanted](https://github.com/rapidsai/nvjitlink/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) labels
2. Find an issue to work on. The best way is to look for the [good first issue](https://github.com/rapidsai/pynvjitlink/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
or [help wanted](https://github.com/rapidsai/pynvjitlink/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) labels
3. Comment on the issue saying you are going to work on it
4. Code! Make sure to update unit tests!
5. When done, [create your pull request](https://github.com/rapidsai/nvjitlink/compare)
5. When done, [create your pull request](https://github.com/rapidsai/pynvjitlink/compare)
6. Verify that CI passes all [status checks](https://help.github.com/articles/about-status-checks/). Fix if needed
7. Wait for other developers to review your code and update code as needed
8. Once reviewed and approved, a RAPIDS developer will merge your pull request
Expand All @@ -39,7 +39,7 @@ and ask for clarifications!
### Seasoned developers

Once you have gotten your feet wet and are more comfortable with the code, you
can look at the prioritized issues of our next release in our [project boards](https://github.com/rapidsai/nvjitlink/projects).
can look at the prioritized issues of our next release in our [project boards](https://github.com/rapidsai/pynvjitlink/projects).

> **Pro Tip:** Always look at the release board with the highest number for
issues to work on. This is where RAPIDS developers also focus their efforts.
Expand Down
26 changes: 14 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,36 @@
# <div align="left"><img src="https://rapids.ai/assets/images/rapids_logo.png" width="90px"/>&nbsp;pynvjitlink</div>

The [RAPIDS](https://rapids.ai) pynvjitlink library provides a Python binding for the
[nvJitLink library](https://docs.nvidia.com/cuda/nvJitLink/index.html). It is presently a
work-in-progress.
[nvJitLink library](https://docs.nvidia.com/cuda/nvJitLink/index.html).

**NOTE:** For the latest stable [README.md](https://github.com/rapidsai/pynvjitlink/blob/main/README.md) ensure you are on the `main` branch.
## Installation with pip

## Quick Start
TODO
```shell
pip install --extra-index-url https://pypi.nvidia.com pynvjitlink-cu12
```

## Install pynvjitlink
## Installation from source

Install with either:

```shell
python -m pip install -e .
python -m pip install .
```

or

```shell
python -m pip install .
python -m pip install -e .
```

### Conda
TODO
for an editable install.

## Installation with Conda

### Docker
TODO

## Contributing Guide

Review the [CONTRIBUTING.md](https://github.com/rapidsai/pynvjitlink/blob/main/CONTRIBUTING.md) file for information on how to contribute code and issues to the project.
Review the
[CONTRIBUTING.md](https://github.com/rapidsai/pynvjitlink/blob/main/CONTRIBUTING.md)
file for information on how to contribute code and issues to the project.