From 5599656da6462502e4b8407298bfa8f2b9b6b460 Mon Sep 17 00:00:00 2001 From: Gregg Miskelly Date: Mon, 16 May 2016 10:16:03 -0700 Subject: [PATCH] Update README.md to reference the OmniSharp extension --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d02941c0a..851af36f2 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,25 @@ |:--:|:--:| |[![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)| -Don't install this extension unless you want to try an early version. - -This is a preview of C# support in Visual Studio code. It is designed to work well with the upcoming [.NET Core 1.0](http://dotnet.github.io/). +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/). These new projects are based on project.json and the [.NET CLI](https://dotnet.github.io/getting-started/). +### Support for .csproj + +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. + +Installation steps for the Omnisharp extension -- + +1. Install ASP.NET 5 RC1 (NOTE: Do **NOT** use RC2) + * Windows: https://docs.asp.net/en/1.0.0-rc1/getting-started/installing-on-windows.html + * OSX: https://docs.asp.net/en/1.0.0-rc1/getting-started/installing-on-mac.html. Follow the instructions for using Mono. + * Linux: https://docs.asp.net/en/1.0.0-rc1/getting-started/installing-on-linux.html. Follow the instructions for using Mono. +2. Bring up the extension list in VS Code by opening the command pallet (F1 key) and type 'ext install'. +3. After VS Code has downloaded the extension list, type 'omnisharp' and select 'Built-in Omnisharp' from the list. +4. Open a C# file. If intellisense isn't working, open the output window (View->Toggle Output) and look at the 'OmniSharp Log'. + ### Debugging This version supports basic debugging capabilities. See http://aka.ms/vscclrdebugger for details.