docs: update changelog with 1.6.0

.github/workflows/run-tests.yml

@@ -12,17 +12,26 @@ jobs:
       - uses: actions/checkout@v4
       - uses: lukka/get-cmake@latest
         with:
-          cmakeVersion: "~3.25.0"  # <--= optional, use most recent 3.25.x version
-          ninjaVersion: "^1.11.1"  # <--= optional, use most recent 1.x version
+          cmakeVersion: "~3.25.0"
+          ninjaVersion: "^1.11.1"
       - name: build
         run: |
           mkdir tmp
           cd tmp
-          cmake -DMADDY_BUILD_WITH_TESTS=ON ..
+          cmake -DMADDY_BUILD_WITH_TESTS=ON -DCMAKE_INSTALL_PREFIX=./install ..
           make -j4
+          make install
       - name: run tests
         run: |
           ./build/MaddyTests
+      - name: test find_package
+        run: |
+          cd tests/cmake/find_package
+          mkdir tmp
+          cd tmp
+          cmake -DCMAKE_PREFIX_PATH=../../../tmp/install ..
+          make -j4
+          ./maddy_find_package_example
 
   test-on-windows:
     runs-on: windows-latest
@@ -30,8 +39,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: lukka/get-cmake@latest
         with:
-          cmakeVersion: "~3.25.0"  # <--= optional, use most recent 3.25.x version
-          ninjaVersion: "^1.11.1"  # <--= optional, use most recent 1.x version
+          cmakeVersion: "~3.25.0"
+          ninjaVersion: "^1.11.1"
       - name: build
         run: |
           mkdir tmp
@@ -48,8 +57,8 @@ jobs:
       - uses: actions/checkout@v4
       - uses: lukka/get-cmake@latest
         with:
-          cmakeVersion: "~3.25.0"  # <--= optional, use most recent 3.25.x version
-          ninjaVersion: "^1.11.1"  # <--= optional, use most recent 1.x version
+          cmakeVersion: "~3.25.0"
+          ninjaVersion: "^1.11.1"
       - name: build
         run: |
           mkdir tmp

CHANGELOG.md

@@ -14,6 +14,10 @@ maddy uses [semver versioning](https://semver.org/).
 
 ## Upcoming
 
+* ...
+
+## version 1.6.0 2025-07-26
+
 * ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added CMake install and find_package() support.
 * ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Script to update maddy version number in all files.
 

CMakeLists.txt

@@ -3,7 +3,7 @@
 
 cmake_minimum_required(VERSION 3.25)
 
-project(maddy VERSION 1.5.0) # MADDY_VERSION_LINE_REPLACEMENT
+project(maddy VERSION 1.6.0) # MADDY_VERSION_LINE_REPLACEMENT
 
 # ------------------------------------------------------------------------------
 

README.md

@@ -1,7 +1,7 @@
 # maddy
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Version: 1.5.0](https://img.shields.io/badge/Version-1.5.0-brightgreen.svg)](https://semver.org/) <!-- MADDY_VERSION_LINE_REPLACEMENT -->
+[![Version: 1.6.0](https://img.shields.io/badge/Version-1.6.0-brightgreen.svg)](https://semver.org/) <!-- MADDY_VERSION_LINE_REPLACEMENT -->
 
 maddy is a C++ Markdown to HTML **header-only** parser library.
 

include/maddy/parser.h

@@ -59,7 +59,7 @@ public:
    */
   static const std::string& version()
   {
-    static const std::string v = "1.5.0"; // MADDY_VERSION_LINE_REPLACEMENT
+    static const std::string v = "1.6.0"; // MADDY_VERSION_LINE_REPLACEMENT
     return v;
   }
 

tests/cmake/find_package/CMakeLists.txt

@@ -0,0 +1,8 @@
+# This project is licensed under the MIT license. For more information see the
+# LICENSE file.
+cmake_minimum_required(VERSION 3.25)
+
+find_package(maddy REQUIRED)
+
+add_executable(maddy_find_package_example main.cpp)
+target_link_libraries(maddy_find_package_example PRIVATE maddy::maddy)

tests/cmake/find_package/main.cpp

@@ -0,0 +1,25 @@
+/*
+ * This project is licensed under the MIT license. For more information see the
+ * LICENSE file.
+ *
+ * This file is a tiny example project to test if find_package works correctly.
+ */
+#include <iostream>
+#include <memory>
+#include <sstream>
+#include <string>
+
+#include "maddy/parser.h"
+
+int main(int argc, char** argv)
+{
+  std::shared_ptr<maddy::Parser> parser = std::make_shared<maddy::Parser>();
+
+  std::stringstream markdownStream;
+  markdownStream << "# Hello World\n"
+                 << "This is a **bold** text and this is *italic* text.\n";
+
+  std::cout << parser->Parse(markdownStream) << std::endl;
+
+  return 0;
+}

tools/format.py

@@ -70,6 +70,11 @@ def format_files(dry_run):
   files_to_format = []
   for pattern in patterns:
     matched_files = glob.glob(pattern, recursive=True)
+
+    for file in matched_files:
+      if '\/tmp\/' in file or '\\tmp\\' in file:
+        matched_files.remove(file)
+
     files_to_format.extend(matched_files)
 
   if not files_to_format: