Skip to content

Commit

Permalink
docs: changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Raúl Gotor committed Dec 24, 2023
1 parent 1e6843b commit 0f98d28
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<img align="center" src="examples/stack_example_map.svg">
<img style="display: block; margin-left: auto; margin-right: auto;" src="examples/stack_example_map.svg">

##### `break`

Expand All @@ -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)
<img style="display: block; margin-left: auto; margin-right: auto;" src="examples/break_example_map.svg">

#### Links

Expand All @@ -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.
Expand Down

0 comments on commit 0f98d28

Please sign in to comment.