Skip to content

Commit 626ce70

Browse files
committed
Updated readme for vs code, added launch targets for console/AspNetCore, added recommended extensions
1 parent ed8885f commit 626ce70

File tree

5 files changed

+71
-8
lines changed

5 files changed

+71
-8
lines changed

.devcontainer/devcontainer.json

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
{
2-
3-
"name": "Exceptionless.Net"
2+
3+
"name": "Exceptionless.Net",
44
"image": "mcr.microsoft.com/vscode/devcontainers/dotnetcore:latest",
55
"extensions": [
66
"ms-dotnettools.csharp",
77
"streetsidesoftware.code-spell-checker",
8-
"tintoy.msbuild-project-tools",
9-
"humao.rest-client",
8+
"tintoy.msbuild-project-tools"
109
]
1110
}

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,4 +165,4 @@ lib
165165
node_modules
166166
App_Data
167167
Exceptionless.sln.GhostDoc.xml
168-
.vs/config/applicationhost.config
168+
.vs/config/applicationhost.config

.vscode/extensions.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"recommendations": [
3+
"ms-dotnettools.csharp",
4+
"streetsidesoftware.code-spell-checker",
5+
"tintoy.msbuild-project-tools"
6+
]
7+
}

.vscode/launch.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"name": "Sample Console",
6+
"type": "coreclr",
7+
"request": "launch",
8+
"preLaunchTask": "Build",
9+
"program": "${workspaceRoot}/samples/Exceptionless.SampleConsole/bin/Debug/netcoreapp3.1/Exceptionless.SampleConsole.dll",
10+
"args": [],
11+
"cwd": "${workspaceRoot}/samples/Exceptionless.SampleConsole",
12+
"stopAtEntry": false,
13+
"console": "integratedTerminal",
14+
"env": {
15+
"AppMode": "Development"
16+
}
17+
},
18+
{
19+
"name": "Sample AspNetCore",
20+
"type": "coreclr",
21+
"request": "launch",
22+
"preLaunchTask": "Build",
23+
"program": "${workspaceRoot}/samples/Exceptionless.SampleAspNetCore/bin/Debug/netcoreapp3.1/Exceptionless.SampleAspNetCore.dll",
24+
"args": [],
25+
"cwd": "${workspaceRoot}/samples/Exceptionless.SampleAspNetCore",
26+
"stopAtEntry": false,
27+
"console": "integratedTerminal",
28+
"env": {
29+
"AppMode": "Development"
30+
}
31+
}
32+
]
33+
}

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,39 @@ Refer to the Exceptionless documentation here: [Exceptionless Docs](http://docs.
1515

1616
## Getting Started (Development)
1717

18-
All of our [.NET clients can be installed](https://www.nuget.org/profiles/exceptionless?showAllPackages=True) via the [NuGet package manager](https://docs.nuget.org/consume/Package-Manager-Dialog). If you need help, please contact us via in-app support or [open an issue](https://github.com/exceptionless/Exceptionless.Net/issues/new). We’re always here to help if you have any questions!
18+
All of our [.NET clients can be installed](https://www.nuget.org/profiles/exceptionless?showAllPackages=True) via the [NuGet package manager](https://docs.nuget.org/consume/Package-Manager-Dialog).
19+
If you need help, please contact us via in-app support or
20+
[open an issue](https://github.com/exceptionless/Exceptionless.Net/issues/new).
21+
We’re always here to help if you have any questions!
1922

20-
**This section is for development purposes only! If you are trying to use the Exceptionless .NET libraries, please get them from NuGet.**
23+
**This section is for development purposes only! If you are trying to use the
24+
Exceptionless .NET libraries, please get them from NuGet.**
2125

22-
1. You will need to have [Visual Studio 2019](http://www.visualstudio.com/products/visual-studio-community-vs) and [.NET Core SDK with VS Tooling](https://www.microsoft.com/net/core) installed.
26+
### Visual Studio
27+
28+
Using Windows and Visual Studio is preferred so all platforms can be built and
29+
editor design surfaces are available.
30+
31+
1. You will need to install:
32+
1. [Visual Studio 2019](https://visualstudio.microsoft.com/vs/community/)
33+
2. [.NET Core 3.1 SDK with VS Tooling](https://dotnet.microsoft.com/download)
34+
3. [.NET Framework 4.6.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/net462)
2335
2. Open the `Exceptionless.Net.sln` Visual Studio solution file.
2436
3. Select `Exceptionless.SampleConsole` as the startup project.
2537
4. Run the project by pressing `F5` to start the console.
2638

39+
### Visual Studio Code
40+
41+
You can also use [Visual Studio Code](https://code.visualstudio.com) and build
42+
on macOS or Linux. You lose some of the rich design surfaces and the ability to
43+
build windows specific packages.
44+
45+
1. You will need to install:
46+
1. [Visual Studio Code](https://code.visualstudio.com)
47+
2. [.NET Core 3.1 SDK with VS Tooling](https://dotnet.microsoft.com/download)
48+
2. Open the cloned Exceptionless.Net folder.
49+
3. Run the `Exceptionless.SampleConsole` project by pressing `F5` to start the console.
50+
2751
## Thanks
2852

2953
Thanks to all the people who have contributed!

0 commit comments

Comments
 (0)