README: render pipeline diagram as an embedded SVG image

GitHub renders mermaid client-side and many previewers do not, so the
flowchart showed as a code block. Commit the rendered SVG (safe, no
scripts) and keep the mermaid source as an HTML comment for editing.
This commit is contained in:
lakshit verma 2026-08-15 04:43:55 +05:30
parent a48b163683
commit 13b06dda1f
No known key found for this signature in database
2 changed files with 5 additions and 2 deletions

View file

@ -18,14 +18,16 @@ naksheap reads the allocator metadata that is already in the dump. It walks glib
The pipeline is one command, end to end. The pipeline is one command, end to end.
```mermaid ![naksheap pipeline](docs/pipeline.svg)
<!-- Source (mermaid), regenerate with mermaid-cli:
flowchart LR flowchart LR
A[core dump] --> B[find arenas and heap regions] A[core dump] --> B[find arenas and heap regions]
B --> C[carve objects: address, size, allocated or freed] B --> C[carve objects: address, size, allocated or freed]
C --> D[scan for pointers between objects, registers, stack] C --> D[scan for pointers between objects, registers, stack]
D --> E[group identical layouts, detect vtables, strings, vectors] D --> E[group identical layouts, detect vtables, strings, vectors]
E --> F[object graph: ASCII, JSON, Graphviz, HTML report] E --> F[object graph: ASCII, JSON, Graphviz, HTML report]
``` -->
## Quick start ## Quick start

1
docs/pipeline.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 16 KiB