Skip to content

Commit

Permalink
Update README.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
mikex86 authored Mar 11, 2025
1 parent ab2ebb5 commit 1379e28
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,27 @@ cmake -DCMAKE_C_COMPILER=cc -DCMAKE_CXX_COMPILER=c++ -DCMAKE_BUILD_TYPE=Release
cmake --build . --config Release --parallel
```

### Recommended way to use the threadpark library

The recommended way to use threadpark in a C/C++ project is to clone the repository and link against the threadpark library in
CMake:

```bash
git clone --recurse https://github.com/PrimeIntellect-ai/threadpark.git
```

Then add the newly cloned repository as a subdirectory in your CMakeLists file:

```cmake
add_subdirectory(threadpark)
```

Then link against the threadpark library

```cmake
target_link_libraries(YourTarget PRIVATE threadpark)
```

## Testing

### C++ Tests
Expand All @@ -177,4 +198,4 @@ This project is licensed under the MIT License.

## Contributing

Contributions are welcome! Please submit issues and pull requests to help improve threadpark.
Contributions are welcome! Please submit issues and pull requests to help improve threadpark.

0 comments on commit 1379e28

Please sign in to comment.