Update readme add doc

.github/actions/coverage_clang/action.yml

@@ -24,17 +24,18 @@ runs:
         # Show summary coverage report
         llvm-cov report ${{ inputs.build-output-dir }}/test/bitlib-tests \
             -instr-profile=coverage.profdata \
-            -ignore-filename-regex='/usr/|_deps/|libpopcnt\.h|test/inc/|test/src/'
+            -ignore-filename-regex='/usr/.*|.*_deps/.*|.*/libpopcnt\.h|.*test/inc/.*|.*test/src/.*'
 
         # Generate HTML report
         llvm-cov show ${{ inputs.build-output-dir }}/test/bitlib-tests \
             -instr-profile=coverage.profdata \
             -format=html \
             -output-dir=out/coverage_clang \
-            -ignore-filename-regex='/usr/|_deps/|libpopcnt\.h|test/inc/|test/src/'
+            -ignore-filename-regex='/usr/.*|.*_deps/.*|.*/libpopcnt\.h|.*test/inc/.*|.*test/src/.*'
 
         llvm-cov export ${{ inputs.build-output-dir }}/test/bitlib-tests \
             -instr-profile=coverage.profdata \
+            -ignore-filename-regex='/usr/.*|.*_deps/.*|.*/libpopcnt\.h|.*test/inc/.*|.*test/src/.*' \
             -format=lcov > coverage_clang.info
 
     - name: Upload coverage artifact

CMakeLists.txt

@@ -1,10 +1,14 @@
-# specify the C++ standard
-cmake_minimum_required(VERSION 3.14)
-cmake_policy(SET CMP0168 NEW)
-cmake_policy(SET CMP0167 NEW)
+cmake_minimum_required(VERSION 3.20)
+
+if (POLICY CMP0168)
+  cmake_policy(SET CMP0168 NEW)
+endif()
+if (POLICY CMP0167)
+  cmake_policy(SET CMP0167 NEW)
+endif()
 
 # set the project name
-project(BitLib VERSION 0.3.0)
+project(BitLib VERSION 1.0.0)
 
 option(BITLIB_HWY "Build with google highway SIMD extensions" OFF)
 option(BITLIB_BENCHMARK "Build bitlib benchmarks" OFF)

LICENSE

@@ -1,4 +1,4 @@
-BSD 3-Clause License
+BitLib BSD 3-Clause License
 
 Copyright (c) 2022, Bryce Kille
 All rights reserved.
@@ -27,3 +27,34 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+--------------------------THIRD-PARTY LICENSES-------------------------------
+
+libpopcnt.h - C/C++ library for counting the number of 1 bits (bit
+population count) in an array as quickly as possible using
+specialized CPU instructions i.e. POPCNT, AVX2, AVX512, NEON.
+
+Copyright (c) 2016 - 2020, Kim Walisch
+Copyright (c) 2016 - 2018, Wojciech Muła
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.