From a4163adbe93a407c74437496fd60af427d9ab6be Mon Sep 17 00:00:00 2001 From: Alexander M Pickering Date: Tue, 21 Jul 2026 20:28:12 -0500 Subject: Add an image of the mermaid diagram --- readme.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index 29cd403..7efa681 100644 --- a/readme.md +++ b/readme.md @@ -110,8 +110,8 @@ Some users may be alarmed, or believe this is a security vulnerability. The reality at the time of publishing is that it is almost all software documentation is generated on computers controlled by the same person or people that wrote the source code, and published on the internet. -If you can trust someone to write some source code that's running on your machine, -you can probably trust them to run some more code to generate documentation. +If you can trust someone to write some code that's running on your machine, +you can probably trust them to run more code to generate documentation. If you are interested in letting third parties generate documentation without reading the code, or you want to generate documentation from untrusted input, `trbldoc` is not right for your project. @@ -137,6 +137,8 @@ sequenceDiagram ]] ``` +trbldoc pipeline diagram + In addition, you can add new kinds of comment blocks, here's how you would add comment blocks for [Nim](https://nim-lang.org/) @@ -273,3 +275,4 @@ tests/ unit/ Unit tests integration/ Integration tests ``` + -- cgit v1.2.3-70-g09d2