Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cracked-machine authored Feb 10, 2024
1 parent bf09131 commit 34a09af
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
[![Build](https://github.com/cracked-machine/mmdiagram/actions/workflows/python-app.yml/badge.svg)](https://github.com/cracked-machine/mmdiagram/actions/workflows/python-app.yml)
[![Codecov](https://img.shields.io/codecov/c/github/cracked-machine/mmdiagram)](https://app.codecov.io/gh/cracked-machine/mmdiagram)

Tool for mapping of regions in memory, specifcally for visualising and troubleshooting region overlap/collision.
Tool for generating diagrams that show the mapping of regions in memory, specifcally for visualising and troubleshooting region overlap/collision.

![](doc/example/tests.test_docs_normal_cropped.png)

![](doc/example/tests.test_docs_normal_table.png)
||
|:-:|
|![](doc/example/tests.test_docs_normal_cropped.png)|
|![](doc/example/tests.test_docs_normal_table.png)|

As well as the `png` format diagram image, a `markdown` report is also created:
- inline image of the diagram
- collision data table

An example can be found in [doc/example/main.md](doc/example/main.md)
More examples can be found in [doc/example/main.md](doc/example/main.md)

### Usage:

Expand Down

0 comments on commit 34a09af

Please sign in to comment.