summaryrefslogtreecommitdiff
path: root/util/README.txt
diff options
context:
space:
mode:
authorMatthias Melcher <github@matthiasm.com>2025-12-28 21:37:23 +0100
committerMatthias Melcher <github@matthiasm.com>2025-12-28 21:37:30 +0100
commitf5e7d62f90f5eb88afad45d56017c42835149d0c (patch)
treed1fae5330c7c107776626466e17aabc3844e6f84 /util/README.txt
parent22c17302616acad9e4eb735d897948dee28942ae (diff)
Generate code block documentation using FLTK (#1353)
The Doxygen-to-pdf toolchain can not easily generate pdf's with Japanese and Chinese characters. This patch generates code blocks by rendering them in FLTK.
Diffstat (limited to 'util/README.txt')
-rw-r--r--util/README.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/util/README.txt b/util/README.txt
index bfafb80fd..c71f6b147 100644
--- a/util/README.txt
+++ b/util/README.txt
@@ -4,3 +4,16 @@ Utility programs used to build the FLTK library.
Contents:
cmap.cxx generate src/fl_cmap.h
+ code_snapshot.cxx PDF documentation tool to generate a png image from a
+ Doxygen `@code` segment with international characters
+
+Build System:
+
+ The util directory includes CMake support. Utilities are built
+ automatically during the build process when needed. Some utilities
+ are only built when specific features are enabled:
+
+ - the PDF documentation helper is only built when FLTK_BUILD_PDF_DOCS=ON
+
+ To add a new utility, edit util/CMakeLists.txt and follow the existing
+ patterns for conditional building and target configuration.