Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
To reflect the current project state, and to fix the broken image link.
  • Loading branch information
gmarkall committed Jan 9, 2024
1 parent ce20b81 commit e6f045d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
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>
# <div align="left"><img src="img/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 -i https://pypi.anaconda.org/rapidsai-wheels-nightly/simple 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.
Binary file added img/rapids_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e6f045d

Please sign in to comment.