📚 Update logging docs

.github/workflows/asciidoctor-ghpages.yml

@@ -42,7 +42,7 @@ jobs:
 
       - name: Install Mermaid
         run: |
-          npm install -g @mermaid-js/mermaid-cli@11.4.2
+          npm install -g @mermaid-js/mermaid-cli@11.12.0
           npx puppeteer browsers install chrome-headless-shell
 
       - name: Install asciidoctor

docs/index.adoc

@@ -13,4 +13,3 @@ include::logging.adoc[]
 include::interrupts.adoc[]
 include::match.adoc[]
 include::message.adoc[]
-include::implementation_details.adoc[]

docs/intro.adoc

@@ -36,7 +36,9 @@ The library dependencies are:
 - https://github.com/intel/cpp-std-extensions[C++ std extensions (`stdx`)]
 - https://github.com/intel/cpp-baremetal-concurrency[Baremetal Concurrency (`conc`)]
 - https://github.com/intel/cpp-senders-and-receivers[Baremetal Senders and Receivers (`async`)]
-- https://github.com/fmtlib/fmt[fmt]
+- https://github.com/fmtlib/fmt[fmtlib]
+
+NOTE: `fmtlib` is used at compile-time only; there is no runtime formatting in `cib`.
 
 === Functionality
 
@@ -54,3 +56,23 @@ Various sub-libraries within CIB form a dependency graph. `cib` is an omnibus
 library that contains all the functionality.
 
 mermaid::library_deps.mmd[format="svg"]
+
+=== Getting Started
+
+`cib` is a header-only library, so you can get started by cloning the repository
+(or bringing it in as a submodule) and adding the include directory to your
+build target. Depending on which part(s) of `cib` you are using, you may also
+need to pull in the dependencies.
+
+Alternatively, consuming `cib` with https://github.com/cpm-cmake/CPM.cmake[CPM]
+can be a couple of lines:
+
+[source,cmake]
+----
+cpmaddpackage("gh:intel/compile-time-init-build#1abcdef")
+
+target_link_libraries(my_project PUBLIC cib)
+----
+
+Where `1abcdef` is the git hash. You can also use any of the sub-libraries (for
+example, `cib_log_binary`) in this way.

docs/log_build_process.mmd

@@ -0,0 +1,30 @@
+block
+columns 6
+  app_cpp("main.cpp") lib_cpp("lib.cpp") space:4
+  space:3 ud("undefined_symbols.txt") space:2
+  space:6
+  block:B:2
+    columns 2
+    obj("main.o")
+    lib("lib.a")
+    space
+    strings("strings.a")
+  end space
+  block:A:3
+    gen_cpp("strings.cpp")
+    gen_json("strings.json")
+    gen_xml("strings.xml")
+  end
+  space:6
+  space app("a.out") space:2 log("log decoder") space
+
+  app_cpp-- "compile" -->obj
+  lib_cpp-- "compile" -->lib
+  lib-- "nm" -->ud
+  ud-- "generate" -->A
+  gen_cpp-- "compile" -->strings
+  gen_cpp-- "compile" -->strings
+  B-- "link + LTO" -->app
+  gen_json-->log
+  gen_xml-->log
+  app-- "run" -->log