From 0f98d2801030f67fc3ffefec2b66fe42e010d472 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Gotor?= Date: Sun, 24 Dec 2023 11:22:54 +0100 Subject: [PATCH] docs: changelog --- CHANGELOG.md | 1 + README.md | 11 +++++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f98777a..1f296f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to * Title feature and property (`title`) for the different areas * `hide-name`, `hide-address` and `hide-size` style properties to hide specific visual elements * `flags` can be specified at map file as well +* `size` property at root level to modify the document size ## [0.2.0] - 2023-12-14 diff --git a/README.md b/README.md index bb744d5..df15822 100644 --- a/README.md +++ b/README.md @@ -220,7 +220,7 @@ areas: These flags specify the section as growing section, for instance, if the section is meant to grow into one direction, such as the stack. When flagging a section with `grows-down`, an arrow pointing downwards will be appended to the bottom of the section indicating that the section is growing into that direction: - + ##### `break` @@ -230,7 +230,7 @@ Reducing the size of the biggest one helps to visually simplify the diagram and There are four different break styles, which can be defined by the 'break-type' style property: `~`: Wave, `≈`: Double wave, `/`: Diagonal, `...`: Dots -![](examples/break_example_map.svg#center) + #### Links @@ -246,6 +246,13 @@ links: sections: [HAL_RCC_OscConfig, __malloc_av_] ``` +#### Other properties + +##### Document size + +The generated SVG document has a fixed size. If you want to adjust it, use the `size` property at root level to pass +desired document width and height in pixels. + ## Run some examples with LinkerScope At the folder examples, there are a series of configurations and map `.yaml` files you can use to get a preview of what LinkerScope can do.