Skip to content

Commit a8d6d14

Browse files
leslierichardson95Wendy Breiding
authored andcommitted
Merged PR 474471: Updated VS Blue Readme
Updated the Readme for the LSP C# Extension (Blue) with additional, updated content and links such as how to get started, how to revert back to O#, etc. Related work items: #1785200
2 parents 8083079 + 34b4615 commit a8d6d14

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
## C# for Visual Studio Code
2-
C# is an extension that contributes to the larger [C# Dev Kit extension]() for Visual Studio Code to provide performant and reliable language support. Under the hood, this extension is powered by a Language Server Protocol (LSP) Tools Host which integrates with open source components like Roslyn (Link to Roslyn) and Razor (link to Razor) to provide rich type information and a faster, more reliable C# experience.
3-
4-
5-
C# is the default language support for [C# Dev Kit]() and is shipped as part of that extension as a required dependency.
2+
C# is the feature-rich, language support for C# and is shipped as part of [C# Dev Kit](csdevkitextension). This version of the extension is currently in pre-release and available for you to use today.
63

4+
C# is an extension that contributes to the [C# Dev Kit extension](csdevkitextension) for Visual Studio Code to provide performant and reliable language support. Under the hood, this extension is powered by a Language Server Protocol (LSP) Tools Host which integrates with open source components like [Roslyn](https://github.com/dotnet/roslyn) and [Razor](https://github.com/dotnet/razor) to provide rich type information and a faster, more reliable C# experience.
75

86
## Recommended Install
9-
While it is possible to use the C# extension as a standalone extension, we highly recommend using the [C# Dev Kit extension]().
7+
While it is possible to use the C# extension as a standalone extension, we highly recommend using [C# Dev Kit](csdevkitextension).
8+
9+
1. Installing [C# Dev Kit](csdevkitextension) will automatically install this extension as a required dependency
10+
2. Open a folder/workspace that contains a C# project (.csproj) and a C# solution (.sln) and the extension will activate.
1011

11-
Installing [C# Dev Kit]() will automatically install this extension as a required dependency
12-
* If working on a solution that requires versions prior to .NET 6, install a Full Framework runtime and MSBuild tooling.
13-
* Set omnisharp.useModernNet to false and dotnet.server.useOmnisharp to true
12+
Note: If working on a solution that requires versions prior to .NET 6, install a Full Framework runtime and MSBuild tooling.
13+
* Set omnisharp.useModernNet to false and if you are on the pre-release verion, set dotnet.server.useOmnisharp to true
1414
* Windows: .NET Framework along with MSBuild Tools
1515
* MacOS/Linux: Mono with MSBuild
1616

@@ -21,11 +21,11 @@ Installing [C# Dev Kit]() will automatically install this extension as a require
2121
* Roslyn powered semantic awareness
2222

2323
## How to use Omnisharp?
24-
If you don’t want to take advantage of the great Language Server features, you can revert back to using Omnisharp by going to the Extension settings and setting `dotnet.server.useOmnisharp` to true. This will require that you restart VS Code to take effect.
24+
If you don’t want to take advantage of the great Language Server features, you can revert back to using Omnisharp in the pre-release extension by going to the Extension settings and setting `dotnet.server.useOmnisharp` to true. This will require that you restart VS Code to take effect. You can also switch back to the Switch to Release Version to revert back to the C# extension powered by OmniSharp.
2525

2626

2727
## Found a Bug?
28-
To file a new issue to include all the related config information directly from vscode by entering the command pallette with Ctrl+Shift+P (Cmd+Shift+P on macOS) and running CSharp: Report an issue command. This will open a browser window with all the necessary information related to the installed extensions, dotnet version, mono version, etc. Enter all the remaining information and hit submit. More information can be found on the wiki .
28+
To file a new issue to include all the related config information directly from vscode by entering the command pallette with Ctrl+Shift+P (Cmd+Shift+P on macOS) and running CSharp: Report an issue command. This will open a browser window with all the necessary information related to the installed extensions, dotnet version, mono version, etc. Enter all the remaining information and hit submit.
2929
Alternatively you could visit https://github.com/dotnet/vscode-csharp/issues and file a new one.
3030

3131

@@ -54,14 +54,19 @@ This project is supported by the [.NET Foundation](http://www.dotnetfoundation.o
5454

5555
## Feedback
5656

57+
<!--
5758
[FAQs]
58-
Check out the FAQs before filing a question.
59+
Check out the FAQs before filing a question.
60+
-->
5961

60-
[Provide feedback]
62+
[Provide feedback](https://github.com/dotnet/vscode-csharp/issues)
6163
File questions, issues, or feature requests for the extension.
6264

63-
[Known issues]
65+
[Known issues](https://github.com/dotnet/vscode-csharp/issues)
6466
If someone has already filed an issue that encompasses your feedback, please leave a 👍 or 👎 reaction on the issue to upvote or downvote it to help us prioritize the issue.
6567

6668
[Quick survey](https://www.research.net/r/8KGJ9V8?o=[o_value]&v=[v_value]&m=[m_value])
67-
Let us know what you think of the extension by taking the quick survey.
69+
Let us know what you think of the extension by taking the quick survey.
70+
71+
72+
[csdevkitextension]: https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.vscodeintellicode-csharp

0 commit comments

Comments
 (0)