feat: Update version to v1.0.2 , Enhance CMake configuration, improve module support, and update README for clarity

Author: moehoshio

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.14)
-project(NekoThreadPool VERSION 1.0.0 LANGUAGES CXX)
+project(NekoThreadPool VERSION 1.0.2 LANGUAGES CXX)
 
 # ================
 # === Config ====
@@ -38,6 +38,7 @@ if(NEKO_THREAD_POOL_AUTO_FETCH_DEPS)
             GIT_REPOSITORY https://github.com/moehoshio/NekoSchema.git
             GIT_TAG        main
         )
+        set(NEKO_SCHEMA_BUILD_TESTS OFF CACHE BOOL "" FORCE)
         if (NEKO_THREAD_POOL_ENABLE_MODULE)
             set(NEKO_SCHEMA_ENABLE_MODULE ON CACHE BOOL "" FORCE)
         endif()
@@ -52,7 +53,6 @@ if(NEKO_THREAD_POOL_AUTO_FETCH_DEPS)
             GIT_REPOSITORY https://github.com/google/googletest.git
             GIT_TAG        v1.17.0
         )
-        # For Windows: Prevent overriding the parent project's compiler/linker settings
         set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
         FetchContent_MakeAvailable(googletest)
     endif()
@@ -130,8 +130,8 @@ if(NEKO_THREAD_POOL_BUILD_TESTS)
     enable_testing()
     message(STATUS "NekoThreadPool tests enabled (NEKO_THREAD_POOL_BUILD_TESTS=ON)")
 
-    if (NOT GTEST_FOUND AND NOT NEKO_THREAD_POOL_AUTO_FETCH_DEPS)
-        message(STATUS "GTest is required for building tests but was not found.")
+    if (NOT Gtest_FOUND AND NOT NEKO_THREAD_POOL_AUTO_FETCH_DEPS)
+        message(WARNING "GTest is required for building tests but was not found.")
         message(FATAL_ERROR "Please enable -DNEKO_THREAD_POOL_AUTO_FETCH_DEPS=ON or install GTest and make it discoverable by CMake. e.g -DCMAKE_PREFIX_PATH=</path/to/googletest>")
     endif()
 

include/neko/thread/neko.thread.cppm

@@ -7,7 +7,9 @@
 
 module;
 
-#if !defined(__cpp_lib_modules) || (__cpp_lib_modules < 202207L)
+#if defined(__cpp_lib_modules) && (__cpp_lib_modules >= 202207L)
+import std;
+#else
 // Global module fragment - include headers that should not be exported
 #include <algorithm>
 #include <functional>
@@ -28,10 +30,11 @@ module;
 #include <string>
 #endif
 
-export module neko.thread;
-
 import neko.schema;
 
+export module neko.thread;
+
+// Control header files to not import dependencies (dependencies are declared and imported by the cppm)
 #define NEKO_THREAD_POOL_ENABLE_MODULE true
 
 export {

include/neko/thread/threadPool.hpp

@@ -7,7 +7,7 @@
  */
 #pragma once
 
-#if !defined(NEKO_THREAD_POOL_ENABLE_MODULE)
+#if !defined(NEKO_THREAD_POOL_ENABLE_MODULE) || (NEKO_THREAD_POOL_ENABLE_MODULE == false)
 #include <neko/schema/exception.hpp>
 #include <neko/schema/types.hpp>
 

packages/vcpkg/neko-threadpool/vcpkg.json

@@ -1,19 +1,18 @@
 {
-    "version": "1.0.1",
-    "port-version": 1,
-    "name": "neko-threadpool",
-    "description": "An easy-to-use and efficient C++ 20 thread pool that supports task priorities and task submission to specific threads.",
-    "homepage": "https://github.com/moehoshio/NekoThreadPool",
-    "license": "MIT OR Apache-2.0",
-    "dependencies": [
-        {
-            "name": "vcpkg-cmake",
-            "host": true
-        },
-        {
-            "name": "vcpkg-cmake-config",
-            "host": true
-        },
-        "neko-schema"
-    ]
-}
+  "name": "neko-threadpool",
+  "version": "1.0.1",
+  "description": "An easy-to-use and efficient C++ 20 thread pool that supports task priorities and task submission to specific threads.",
+  "homepage": "https://github.com/moehoshio/NekoThreadPool",
+  "license": "MIT OR Apache-2.0",
+  "dependencies": [
+    "neko-schema",
+    {
+      "name": "vcpkg-cmake",
+      "host": true
+    },
+    {
+      "name": "vcpkg-cmake-config",
+      "host": true
+    }
+  ]
+}

readme.md

@@ -5,6 +5,7 @@ An easy-to-use and efficient C++ 20 thread pool that supports task priorities an
 [![License](https://img.shields.io/badge/License-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE)
 ![Require](https://img.shields.io/badge/%20Require%20-%3E=%20C++%2020-orange.svg)
 [![CMake](https://img.shields.io/badge/CMake-3.14+-green.svg)](https://cmake.org/)
+![Module Support](https://img.shields.io/badge/Modules-C%2B%2B20-blueviolet.svg)
 
 ## Features
 
@@ -21,7 +22,7 @@ An easy-to-use and efficient C++ 20 thread pool that supports task priorities an
 
 ## Quick Start
 
-Configuration: [CMake](#cmake) | [Manual](#manual) | [Test](#test)
+Configuration: [CMake](#cmake) | [vcpkg](#vcpkg) | [Conan](#conan) |[Manual](#manual) | [Test](#test)
 
 Example: [Basic Usage](#basic-usage) | [Tasks with Parameters](#tasks-with-parameters) | [Set Maximum Queue Size](#set-maximum-queue-size) | [Dynamic Thread Count Adjustment](#dynamic-thread-count-adjustment) | [Error Handling](#error-handling)
 
@@ -54,81 +55,172 @@ target_link_libraries(your_target PRIVATE Neko::ThreadPool)
 #include <neko/thread/threadPool.hpp>
 ```
 
-### Manual
+#### CMake with Module Support
 
-When installing manually, you need to manually fetch the dependency [`NekoSchema`](https://github.com/moehoshio/NekoSchema).
+To enable C++20 module support, use the `NEKO_THREAD_POOL_ENABLE_MODULE` option:
 
-After installing the dependency, please continue:
+```cmake
+FetchContent_Declare(
+    ...
+)
 
-1. Clone or download the repository to your host
+# Set Options Before Building
+set(NEKO_THREAD_POOL_ENABLE_MODULE ON CACHE BOOL "" FORCE)
+FetchContent_MakeAvailable(NekoThreadPool)
 
-```sh
-git clone https://github.com/moehoshio/NekoThreadPool.git
+...
+
+target_link_libraries(your_target PRIVATE Neko::ThreadPool::Module)
 ```
 
-or
+Import the module in your source code:
 
-```sh
-curl -L -o NekoThreadPool.zip https://github.com/moehoshio/NekoThreadPool/archive/refs/heads/main.zip
+```cpp
+import neko.thread;
+```
 
-unzip NekoThreadPool.zip
+### vcpkg
+
+Install NekoThreadPool using vcpkg:
+
+```shell
+vcpkg install neko-threadpool
 ```
 
-2. Copy the contents of the `NekoThreadPool/include` folder into your project's `include` directory.
+Or add it to your `vcpkg.json`:
+
+```json
+{
+  "dependencies": ["neko-threadpool"]
+}
+```
+
+Then in your CMakeLists.txt:
+
+```cmake
+find_package(NekoThreadPool CONFIG REQUIRED)
+target_link_libraries(your_target PRIVATE Neko::ThreadPool)
+```
+
+When configuring your project, specify the vcpkg toolchain file:
 
 ```shell
-cp -r NekoThreadPool/include/ /path/to/your/include/
+cmake -B build -DCMAKE_PREFIX_PATH=/path/to/vcpkg/installed/x64-windows
+cmake --build build --config Debug
 ```
 
-3. Include the header in your source code
+Note: Installing via vcpkg does not support modules.
 
-```cpp
-#include <neko/core/threadPool.hpp>
+### Conan
+
+Add NekoThreadPool to your `conanfile.txt`:
+
+```ini
+[requires]
+neko-threadpool/*
+
+[generators]
+CMakeDeps
+CMakeToolchain
 ```
 
-### C++20 Module Support
+Or use it in your `conanfile.py`:
 
-NekoThreadPool supports C++20 modules
+```python
+from conan import ConanFile
 
-#### Building with Module Support
+class YourProject(ConanFile):
+    requires = "neko-threadpool/*"
+    generators = "CMakeDeps", "CMakeToolchain"
+```
 
-To enable C++20 module support, use the `NEKO_THREAD_POOL_ENABLE_MODULE` option:
+Then install and use:
+
+```shell
+conan install . --build=missing
+cmake -B build -DCMAKE_TOOLCHAIN_FILE=build/conan_toolchain.cmake
+cmake --build build
+```
+
+In your CMakeLists.txt:
 
 ```cmake
-include(FetchContent)
+find_package(NekoThreadPool CONFIG REQUIRED)
+target_link_libraries(your_target PRIVATE Neko::ThreadPool)
+```
 
-FetchContent_Declare(
-    NekoSchema
-    GIT_REPOSITORY https://github.com/moehoshio/NekoSchema.git
-    GIT_TAG        main
-)
+#### Conan with C++20 Module Support
 
-# Enable module support
-set(NEKO_THREAD_POOL_ENABLE_MODULE ON CACHE BOOL "" FORCE)
+To enable C++20 module support with Conan, use the `enable_module` option:
 
-FetchContent_MakeAvailable(NekoSchema)
+```shell
+conan install . --build=missing -o neko-threadpool/*:enable_module=True
+```
 
-# Link against the module target
-add_executable(your_target main.cpp)
+Or specify it in your `conanfile.txt`:
+
+```ini
+[requires]
+neko-threadpool/*
+
+[options]
+neko-threadpool/*:enable_module=True
+
+[generators]
+CMakeDeps
+CMakeToolchain
+```
+
+Or in your `conanfile.py`:
+
+```python
+from conan import ConanFile
+
+class YourProject(ConanFile):
+    requires = "neko-threadpool/*"
+    generators = "CMakeDeps", "CMakeToolchain"
+    
+    def configure(self):
+        self.options["neko-threadpool"].enable_module = True
+```
+
+Then link against the module target in your CMakeLists.txt:
+
+```cmake
+find_package(NekoThreadPool CONFIG REQUIRED)
 target_link_libraries(your_target PRIVATE Neko::ThreadPool::Module)
 ```
 
-#### Using the Module
+### Manual
 
-Instead of including headers, simply import the module:
+When installing manually, you need to manually fetch the dependency [`NekoSchema`](https://github.com/moehoshio/NekoSchema).
 
-```cpp
-#include <iostream>
-import neko.thread;
+After installing the dependency, please continue:
 
-int main() {
-    neko::thread::ThreadPool pool;
-    auto future = pool.submit([]() {
-        return 42;
-    });
-    std::cout << "Result: " << future.get() << std::endl;
-    return 0;
-}
+1. Clone or download the repository to your host
+
+```sh
+git clone https://github.com/moehoshio/NekoThreadPool.git
+```
+
+or
+
+```sh
+curl -L -o NekoThreadPool.zip https://github.com/moehoshio/NekoThreadPool/archive/refs/heads/main.zip
+
+unzip NekoThreadPool.zip
+```
+
+2. Copy the contents of the `NekoThreadPool/include` folder into your project's `include` directory.
+
+```shell
+cp -r NekoThreadPool/include/ /path/to/your/include/
+```
+
+3. Include the header in your source code
+
+```cpp
+#include <neko/core/threadPool.hpp>
 ```
 
 ### Basic Usage