Initial release v0.1.0

Author: kzhdev

.gitignore

@@ -39,3 +39,7 @@
 
 # debug information files
 *.dwo
+
+build/
+.vscode/
+

CHANGELOG

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-01-23
+
+### Added
+- Initial release of slick_object_pool
+- Lock-free multi-producer multi-consumer (MPMC) object pool implementation
+- Header-only library design for easy integration
+- C++20 compliant implementation
+- Cache-line aligned atomic operations to prevent false sharing
+- O(1) constant-time allocation and deallocation
+- Power-of-2 ring buffer with efficient bitwise indexing
+- Automatic heap fallback when pool is exhausted
+- Cross-platform support (Windows, Linux, macOS)
+- Comprehensive test suite with Google Test
+- CMake build system with FetchContent support
+- Support for AddressSanitizer, ThreadSanitizer, and UndefinedBehaviorSanitizer
+- Type safety with static assertions for trivially copyable types
+- Thread-safe operations for concurrent access
+- Detailed documentation and usage examples
+- MIT License
+
+### Features
+- `ObjectPool<T>` class template for type-safe object pooling
+- `allocate_object()` method for O(1) object allocation
+- `free_object()` method for O(1) object deallocation
+- `size()` method to query pool capacity
+- Namespace: `slick::ObjectPool<T>`
+- Include path: `<slick/object_pool.h>`
+
+### Documentation
+- Comprehensive README with architecture details
+- Usage examples for basic, multi-threaded scenarios
+- API reference documentation
+- Performance benchmarks and comparisons
+- Best practices and limitations guide
+- TESTING.md with detailed sanitizer instructions
+- DOCUMENTATION.md with implementation details
+
+### Platform Support
+- Windows (MSVC, MinGW)
+- Linux (GCC 10+, Clang 11+)
+- macOS (Clang 11+)
+- POSIX-compliant systems
+
+[0.1.0]: https://github.com/SlickQuant/slick_object_pool/releases/tag/v0.1.0

CMakeLists.txt

@@ -0,0 +1,51 @@
+cmake_minimum_required(VERSION 3.25)
+
+set(BUILD_VERSION 0.1.0)
+project(slick_object_pool VERSION ${BUILD_VERSION} LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+# Add header-only library
+add_library(slick_object_pool INTERFACE)
+target_include_directories(slick_object_pool INTERFACE 
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:include>
+)
+if(UNIX AND NOT APPLE)
+    target_link_libraries(slick_object_pool INTERFACE rt atomic)
+endif()
+
+option(BUILD_SLICK_OBJECTPOOL_TESTS "Build tests" ON)
+if(BUILD_SLICK_OBJECTPOOL_TESTS)
+    if (WIN32)
+        add_subdirectory(tests)
+    else()
+        add_subdirectory(tests EXCLUDE_FROM_ALL)
+    endif()
+endif()
+
+# Installation rules
+install(DIRECTORY include/ DESTINATION include)
+
+message(STATUS "slick_object_pool: ${BUILD_VERSION}")
+
+if(CMAKE_BUILD_TYPE STREQUAL "Release")
+    add_custom_target(dist_slick_object_pool ALL
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/include ${CMAKE_BINARY_DIR}/dist/include
+        WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+        COMMENT "Copying slick_object_pool headers to dist/include"
+        VERBATIM
+    )
+
+    if (PROJECT_IS_TOP_LEVEL)
+        add_custom_target(package_slick_object_pool ALL
+            COMMAND ${CMAKE_COMMAND} -E tar "cfv" "${CMAKE_BINARY_DIR}/dist/slick_object_pool_${BUILD_VERSION}.zip" --format=zip "include"
+            WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/dist"
+            COMMENT "Creating zip archive"
+        )
+
+        add_dependencies(package_slick_object_pool dist_slick_object_pool)
+    endif()
+endif()