Skip to content

Commit 7878eb2

Browse files
Merge pull request #341 from DustinCampbell/readme-cleanup
Readme cleanup
2 parents b63f69c + fa8e77d commit 7878eb2

File tree

2 files changed

+18
-17
lines changed

2 files changed

+18
-17
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,25 @@
44
|:--:|:--:|
55
|[![Master Build Status](https://travis-ci.org/OmniSharp/omnisharp-vscode.svg?branch=master)](https://travis-ci.org/OmniSharp/omnisharp-vscode)|[![Dev Build Status](https://travis-ci.org/OmniSharp/omnisharp-vscode.svg?branch=dev)](https://travis-ci.org/OmniSharp/omnisharp-vscode)|
66

7-
This is a preview of C# support in Visual Studio code. It is designed to work well with [.NET Core 1.0](http://dotnet.github.io/).
8-
These new projects are based on project.json and the [.NET CLI](https://dotnet.github.io/getting-started/).
7+
Welcome to the C# extension for Visual Studio Code! This preview provides the following features inside VS Code:
98

10-
### Support for .csproj and Mono on OS X and Linux
9+
* Lightweight development tools for [.NET Core](https://dotnet.github.io).
10+
* Great C# editing support, including Syntax Highlighting, IntelliSense, Go to Definition, Find All References, etc.
11+
* Debugging support for .NET Core (CoreCLR). NOTE: Mono and Desktop CLR debugging is not supported.
12+
* Support for project.json projects on Windows, OS X and Linux, and csproj projects on Windows.
1113

12-
Support for .csproj projects will be improved in future versions of this extension. For now, if you are targeting Mono scenarios (ex: Unity or Xamarin) we suggest instead installing the 'Built-in Omnisharp' extension. Note that the name of the OmniSharp extension is no longer correct - the extension is no longer built into VS Code.
14+
The C# extension is powered by [OmniSharp](https://github.com/OmniSharp/omnisharp-roslyn).
1315

14-
Use the following steps to install the older OmniSharp extension for Mono support:
16+
### **Important!** Breaking Changes as of 1.0.10
1517

16-
1. Install ASP.NET 5 RC1 (NOTE: Do **NOT** use RC2)
17-
* Windows: https://docs.asp.net/en/1.0.0-rc1/getting-started/installing-on-windows.html
18-
* OSX: https://docs.asp.net/en/1.0.0-rc1/getting-started/installing-on-mac.html. Follow the instructions for using Mono.
19-
* Linux: https://docs.asp.net/en/1.0.0-rc1/getting-started/installing-on-linux.html. Follow the instructions for using Mono.
20-
2. Bring up the extension list in VS Code by opening the command pallet (F1 key) and type 'ext install'.
21-
3. After VS Code has downloaded the extension list, type 'omnisharp' and select 'Built-in Omnisharp' from the list.
22-
4. Open a C# file. If intellisense isn't working, open the output window (View->Toggle Output) and look at the 'OmniSharp Log'.
18+
* The C# extension now only supports [.NET Core RC2](https://blogs.msdn.microsoft.com/dotnet/2016/05/16/announcing-net-core-rc2/). It no longer supports .NET Core RC1 or ASP .NET 5 RC1.
19+
* **Support for .csproj projects has been temporarily disabled on OS X and Linux.** This will impact anyone doing .csproj development on OS X or Linux (e.g. Unity, Xamarin, etc.). Rest assured that this will be restored in the near future. However, for now, you can use the [Legacy C# Support extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.omnisharp).
20+
21+
### Found a Bug?
22+
Please file any issues at https://github.com/OmniSharp/omnisharp-vscode/issues.
2323

2424
### Debugging
25-
This version supports basic debugging capabilities.
26-
See http://aka.ms/vscclrdebugger for details.
25+
The C# extension now supports basic debugging capabilities! See http://aka.ms/vscclrdebugger for details.
2726

2827
### Development
2928
To **run and develop** do the following:
@@ -33,7 +32,6 @@ To **run and develop** do the following:
3332
* *Optional:* run `tsc -w`, make code changes (on Windows, try `start node ".\node_modules\typescript\bin\tsc -w"`)
3433
* Press F5 to debug
3534

36-
37-
## License
35+
### License
3836
The Microsoft C# extension is subject to [these license terms](RuntimeLicenses/license.txt).
3937
The source code to this extension is available on [https://github.com/OmniSharp/omnisharp-vscode](https://github.com/OmniSharp/omnisharp-vscode) and licensed under the [MIT license](LICENSE.txt).

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
{
22
"name": "csharp",
33
"publisher": "ms-vscode",
4-
"version": "1.0.10",
4+
"version": "1.0.11",
55
"description": "C# for Visual Studio Code (powered by OmniSharp).",
66
"displayName": "C#",
77
"author": "Microsoft Corporation",
88
"license": "SEE LICENSE IN RuntimeLicenses/license.txt",
99
"icon": "images/csharpIcon.png",
1010
"preview": "true",
11+
"bugs": {
12+
"url": "https://github.com/OmniSharp/omnisharp-vscode/issues"
13+
},
1114
"categories": [
1215
"Debuggers",
1316
"Languages",

0 commit comments

Comments
 (0)