Skip to content

Commit a8537fb

Browse files
committed
update readme and screenshots
1 parent a02d3ea commit a8537fb

File tree

9 files changed

+14
-19
lines changed

9 files changed

+14
-19
lines changed

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2017 Peter van der Woude
3+
Copyright (c) 2008-2018 Peter van der Woude
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,35 @@
11
<sub><sup>We've just moved over from CodePlex so this is now the official home of the Exception Reporter</sub></sup>
22

3-
43
# Exception Reporter.NET
5-
Exception Reporter is a .NET component that shows collects detailed information on an
6-
Exception and the application/system running it
74

85
### The nuget package
96
[![NuGet](https://img.shields.io/nuget/v/ExceptionReporter.svg)](https://www.nuget.org/packages/ExceptionReporter/)
107
```
118
PM> Install-Package ExceptionReporter
129
```
1310

14-
### The assemblies
15-
For the un-nugetted, you can find the binaries for ExceptionReporter in the latest release. But note, there are now nuget dependencies for 2 libraries (DotNetZip,SimpleMAPI.NET) - so those libraries have to be referenced as well (included in the release binary).
16-
1711
## How it Looks
1812

19-
Many interface elements can be configured: whether buttons have images, what text appears in the labels,
20-
font-sizes/colors, which tabs are shown etc
21-
22-
This is the simple/less detail version
13+
If you choose to show a dialog (and you don't have to, there is an API for getting the info and keeping it to yourself) there are 2 *modes* - *less details* and *more details*
2314

24-
![](images/er-lessdetail.png)
15+
### **Less Detail** mode
16+
![Compact Mode](images/er2-less-detail.png)
2517

26-
This screenshot below show the more detailed configuration, including an input for user as well as tabular information (this is useful for technical users)
18+
### **More Detail** mode
19+
![More Detail Mode](images/er2-more-detail.png)
2720

28-
![](images/er-user-input.png)
29-
30-
In this example, there are no images on the buttons,
21+
#### Interface Configuration Options
22+
In the next screenshot, we have an example of some customization that can be made with *configuration*.
23+
There are no images on the buttons,
3124
the window title is customised and an extra Tab (_Contact_) is visible
3225

33-
![](images/er-exceptions-tab.png)
26+
![Customized Example](images/er-customized.png)
27+
28+
The buttons for *More detail* and *Less Detail* allow the user to switch between these modes.
3429

3530
## How it works
3631

37-
The Exception Reporter is invoked manually or by setting up it's invocation on an event, where it's basically passed the root Exception -
32+
The Exception Reporter is invoked manually or by setting up it's invocation on a Windows Error event, where it's basically passed the root Exception -
3833
see [Sample Usage](https://github.com/PandaWood/Exception-Reporter/wiki/Sample-Usage)
3934

4035
The user is shown this dialog which is auto-populated with the exception it was given and certain system details.
@@ -45,7 +40,7 @@ The ultimate goal is the developer receiving a formatted exception report - see
4540

4641

4742
## Some Important Features
48-
(Note: these seem to be the features that the similar but simpler project [Crash Reporter.NET](https://github.com/ravibpatel/CrashReporter.NET) doesn't have)
43+
(Note: most of these seem to be the features that similar projects don't have)
4944

5045
- Support for inner exceptions and passing multiple exceptions (ie a list of exceptions)
5146
- Support for generating a report without showing a dialog (see ExceptionReportGenerator class)

images/er-lessdetail.png

-23.7 KB
Binary file not shown.

images/er-user-input.png

-61.6 KB
Binary file not shown.

images/er2-less-detail.png

19 KB
Loading

images/er2-more-detail.png

30.8 KB
Loading
21.9 KB
Loading
37.6 KB
Loading

0 commit comments

Comments
 (0)