Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sleeepyjack committed Nov 17, 2023
1 parent b4757b4 commit c8d93b0
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,7 @@ This will take care of downloading `cuCollections` from GitHub and making the he

`cuCollections` depends on the following libraries:

- [libcu++](https://github.com/NVIDIA/libcudacxx)
- [CUB](https://github.com/thrust/cub)
- [CUDA C++ Core Libraries (CCCL)](https://github.com/NVIDIA/cccl)

No action is required from the user to satisfy these dependencies. `cuCollections`'s CMake script is configured to first search the system for these libraries, and if they are not found, to automatically fetch them from GitHub.

Expand All @@ -80,9 +79,11 @@ make
```
Binaries will be built into:
- `build/tests/`
- `build/gbenchmarks/`
- `build/benchmarks/`
- `build/examples/`

Alternatively, you can use the build script located at 'ci/build.sh'. Calling this script with no arguments will trigger a full build which will be located at 'build/local'.
For a comprehensive list of all available options along with descriptions, you can use the option 'ci/build.sh -h'.

## Code Formatting
By default, `cuCollections` uses [`pre-commit.ci`](https://pre-commit.ci/) along with [`mirrors-clang-format`](https://github.com/pre-commit/mirrors-clang-format) to automatically format the C++/CUDA files in a pull request.
Expand Down

0 comments on commit c8d93b0

Please sign in to comment.