Skip to content

Commit

Permalink
docs: Fix instructions for CairoSVG
Browse files Browse the repository at this point in the history
  • Loading branch information
huyenngn committed Oct 5, 2023
1 parent 6d93a34 commit ac3c4b3
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@ pip install -e '.[docs,test]'
pre-commit install
```
# Current limitations
The SVGs on diagram work items are not stable, meaning that although the content remains the same, symbols and other decorative or stylistic elements may have new IDs. This caused diagram work items to always be patched, regardless of whether or not there were visual changes. As a workaround, SVGs are converted to the PNG format before calculating the checksum. For this the [cairosvg](https://pypi.org/project/CairoSVG/) library is needed which depends on additional libraries. See
the official [CairoSVG documentation](https://cairosvg.org/documentation/#installation) for detailed instructions.
The SVGs on diagram work items are not stable, meaning that although the content remains the same, symbols and other decorative or stylistic elements may have new IDs. This caused diagram work items to always be patched, regardless of whether or not there were visual changes. As a workaround, SVGs are converted to the PNG format before calculating the checksum. For this the [cairosvg](https://pypi.org/project/CairoSVG/) library is needed which depends on additional libraries. See the official [CairoSVG documentation](https://cairosvg.org/documentation/#installation) for detailed instructions.

# Contributing

Expand Down

0 comments on commit ac3c4b3

Please sign in to comment.