Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use mermaid for "defmt ecosystem" diagram #764

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

- [#766] `decoder::log`: Rename `PrettyLogger` to `StdoutLogger`
- [#765]: `defmt-decoder`: Add support for customizable logger formatting
- [#764]: Use mermaid for "defmt ecosystem" diagram

[#766]: https://github.com/knurling-rs/defmt/pull/766
[#765]: https://github.com/knurling-rs/defmt/pull/765
[#764]: https://github.com/knurling-rs/defmt/pull/764

## [v0.3.5] - 2023-06-19

Expand Down
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,40 @@ It still might work on older rust versions, but this isn't ensured.

The following diagram illustrates the user-facing and internal crates of the defmt framework.

![defmt crates structure](assets/defmt.png)
```mermaid
%%{ init: { 'flowchart': { 'curve': 'step', "defaultRenderer": "elk" } } }%%
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"defaultRenderer": "elk" seems to be the culprit for the ~~~ invisible link not working.

graph TD;
A[[defmt]]
B[defmt-decoder]
C[defmt-itm]
D[defmt-macros]
E[defmt-parser]
F[defmt-print]
G[defmt-rtt]
H(defmt-semihosting)
I[[defmt-test]]
J[defmt-test-macros]
K[[flip-link]]
L[panic-probe]
M[[probe-run]]
N(qemu-run)

A --> D
B & D --o E
C & G & H & I & L --> A
F & M & N --o B
I --o J

subgraph Legend
O[[user facing crate]]
P[internal crate]
Q(unreleased crate)
O -- dependency --> P
Q -- pinned dependency --o P
end

J ~~~ Legend
BriocheBerlin marked this conversation as resolved.
Show resolved Hide resolved
```

## Developer Information

Expand Down
1 change: 0 additions & 1 deletion assets/defmt.drawio

This file was deleted.

Binary file removed assets/defmt.png
Binary file not shown.
Loading