Skip to content

Commit

Permalink
README.md: Add table with links to language-specific docs (#62)
Browse files Browse the repository at this point in the history
Co-authored-by: Evan Ramos <[email protected]>
  • Loading branch information
jrhemstad and evanramos-nvidia authored Dec 17, 2024
1 parent c19ecc1 commit 12a094e
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ NVTX is a cross-platform API for annotating source code to provide contextual in

The NVTX API is written in C, with wrappers provided for C++ and Python.

| [C Docs](https://nvidia.github.io/NVTX/doxygen/) | [C++ Docs](https://nvidia.github.io/NVTX/doxygen-cpp/) | [Python Docs](https://nvtx.readthedocs.io/en/latest/) |
| --- | --- | --- |

# What does NVTX do?

By default, NVTX API calls do _nothing_. When you launch a program from a developer tool, NVTX calls in that program are redirected to functions in the tool. Developer tools are free to implement NVTX API calls however they wish.
Expand Down

0 comments on commit 12a094e

Please sign in to comment.