diff --git a/README.MD b/README.MD index 28d3195..930828a 100644 --- a/README.MD +++ b/README.MD @@ -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 @@ -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. \ No newline at end of file +Contributions are welcome! Please submit issues and pull requests to help improve threadpark.