Skip to content

Commit 8576f3d

Browse files
authored
Simplify readme and add badges
1 parent bac3d29 commit 8576f3d

File tree

1 file changed

+18
-29
lines changed

1 file changed

+18
-29
lines changed

README.md

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Graphical Debugging
2-
## extension for Visual Studio 2013, 2015, 2017 and 2019
2+
### Extension for Visual Studio 2013, 2015, 2017 and 2019
3+
4+
[![VS Marketplace](https://vsmarketplacebadge.apphb.com/version-short/AdamWulkiewicz.GraphicalDebugging.svg)](https://marketplace.visualstudio.com/items?itemName=AdamWulkiewicz.GraphicalDebugging)
5+
[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/AdamWulkiewicz.GraphicalDebugging.svg)](https://marketplace.visualstudio.com/items?itemName=AdamWulkiewicz.GraphicalDebugging)
6+
[![Rating](https://vsmarketplacebadge.apphb.com/rating-short/AdamWulkiewicz.GraphicalDebugging.svg)](https://marketplace.visualstudio.com/items?itemName=AdamWulkiewicz.GraphicalDebugging)
7+
![License](https://img.shields.io/github/license/awulkiew/graphical-debugging.svg)
8+
[![Donate](https://img.shields.io/badge/Donate-_-yellow.svg)](https://awulkiew.github.io/donate)
39

410
This extension allows to display graphical representation of C++ and C# variables during debugging.
511

@@ -14,21 +20,11 @@ It supports Boost.Geometry and Boost.Polygon models, Boost.Variant, STL/Boost co
1420

1521
Feel free to report bugs, propose features and create pull requests. Any help is appreciated.
1622

17-
##### Download
23+
#### Download
1824

1925
You can download this extension from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=AdamWulkiewicz.GraphicalDebugging) or [GitHub](https://github.com/awulkiew/graphical-debugging/releases).
2026

21-
##### Instructions
22-
23-
###### Build
24-
25-
You need Microsoft Visual Studio 2017 Community and .NET Framework 4.5.2.
26-
27-
###### Install
28-
29-
To install after building double-click the *.vsix file from bin/Debug or bin/Release directory.
30-
31-
###### Use
27+
#### Instructions
3228

3329
1. place a breakpoint somewhere in the code
3430
2. start debugging
@@ -38,9 +34,7 @@ To install after building double-click the *.vsix file from bin/Debug or bin/Rel
3834
* **View**->**Other Windows**->**Plot Watch**
3935
4. write the name of a variable in an edit box on the list
4036

41-
#### Details
42-
43-
##### Debugger visualizers
37+
#### Debugger visualizers
4438

4539
![Watch](images/natvis_watch.png)
4640

@@ -58,7 +52,7 @@ Supported:
5852
* Boost.Tuple: `tuple`
5953
* Boost.Variant: `variant`
6054

61-
##### Geometry Watch
55+
#### Geometry Watch
6256

6357
Watch window displaying graphical representation of variables in a single image. This allows to compare the variables easily. Variables can be of any supported type (see below) representing a geometrical object, e.g. point, polygon, ray, container of complex numbers, etc.
6458

@@ -78,7 +72,7 @@ where geometries are Boost.Geometry types:
7872
{{0, 10},{-15, 20},{-50, 50},{0, 60}}}};
7973
multi_point_sd_t mpt_sd{{0, 0},{90, 10},{170, 20},{-170, 30}};
8074

81-
##### Graphical Watch
75+
#### Graphical Watch
8276

8377
Watch window displaying graphical representations of variables in a list. Each variable is placed and visualized in a separate row. Variables can be of any supported type (see below) incl. images (see below).
8478

@@ -98,13 +92,13 @@ where
9892
{{0, 10},{-15, 20},{-50, 50},{0, 60}}}};
9993
multi_point_sd_t mpt_sd{{0, 0},{90, 10},{170, 20},{-170, 30}};
10094

101-
##### Plot Watch
95+
#### Plot Watch
10296

10397
Watch window displaying plot representation of variables in a single image. Type of plot can be set in **Options**. Variables can be of any supported type (see below) representing a container of values or points incl. complex and pair.
10498

10599
![Plot Watch](images/plot_watch.png)
106100

107-
##### Types supported in watch windows
101+
#### Supported types
108102

109103
* Containers of values convertible to double, points and other geometries
110104
* C-style array
@@ -133,7 +127,7 @@ Watch window displaying plot representation of variables in a single image. Type
133127
* Variants of geometries
134128
* Boost.Variant: `variant`
135129

136-
##### User-defined types
130+
#### User-defined types
137131

138132
The extension offers support for the following user-defined geometries for both C++ and C# types:
139133

@@ -197,7 +191,7 @@ Current limitations:
197191

198192
See more [examples at GitHub](https://github.com/awulkiew/graphical-debugging/tree/master/examples).
199193

200-
##### Direct memory access
194+
#### Direct memory access
201195

202196
The extension attempts to obtain data through direct memory access if possible. From this feature benefit all supported containers of fundamental numeric types and geometries using such coordinate types. E.g.:
203197
* `int arr[5]`
@@ -213,21 +207,16 @@ The extension attempts to obtain data through direct memory access if possible.
213207

214208
This behavior is enabled by default but can be disabled in options under **Tools**->**Options**->**Graphical Debugging**->**General**
215209

216-
##### Zooming/cropping
210+
#### Zooming/cropping
217211

218212
Geometry Watch and Plot Watch has zooming/cropping feature. Mouse wheel can be used to zoom in/out as well.
219213

220214
![Geometry Watch Zoom](images/geometry_watch_zoom.png)
221215

222216
![Geometry Watch Zoomed](images/geometry_watch_zoomed.png)
223217

224-
##### Options
218+
#### Options
225219

226220
Options for each Watch can be found under **Tools**->**Options**->**Graphical Debugging**
227221

228222
![Plot Watch Various](images/plot_watch_various.png)
229-
230-
##### Themes
231-
232-
The extension supports Visual Studio themes. The visualization of variables may be drawn in two versions, dark or light depending on the brightness of the theme background color.
233-

0 commit comments

Comments
 (0)