omnisharp-vscode/README.md

## C# for Visual Studio Code (powered by OmniSharp)

|Master|Release|
|:--:|:--:|
|[![Master Build Status](https://travis-ci.org/OmniSharp/omnisharp-vscode.svg?branch=master)](https://travis-ci.org/OmniSharp/omnisharp-vscode)|[![Release Build Status](https://travis-ci.org/OmniSharp/omnisharp-vscode.svg?branch=release)](https://travis-ci.org/OmniSharp/omnisharp-vscode)|

Welcome to the C# extension for Visual Studio Code! This preview provides the following features inside VS Code:

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

The C# extension is powered by [OmniSharp](https://github.com/OmniSharp/omnisharp-roslyn).

### Get Started Writing C# in VS Code

* [Documentation](https://code.visualstudio.com/docs/languages/csharp)
* [Video Tutorial compiling with .NET Core](https://channel9.msdn.com/Blogs/dotnet/Get-started-VSCode-Csharp-NET-Core-Windows)

### What's New in 1.14.0

* Support for C# 7.2
* Debugger support for extracting source files embedded in PDBs
* Preliminary support for Linux ARM debugging
* Improved Symbol/Documentation text display
* Addressed problems with projects not being refreshed by OmniSharp after a package restore
* Added option to disable warning about project.json deprecation
* Many other bug fixes!

See our [change log](https://github.com/OmniSharp/omnisharp-vscode/blob/v1.14.0/CHANGELOG.md) for all of the updates.

### Supported Operating Systems for Debugging

* Currently, the C# debugger officially supports the following operating systems:

  * Windows (64-bit only)
  * macOS 10.12 (Sierra) and newer
  * Ubuntu 14.04+ (and distros based on it)
  * Debian 8.7+
  * Red Hat Enterprise Linux (RHEL) / CentOS / Oracle Linux 7.3+
  * Fedora 23 / 24 / 25
  * OpenSUSE 42.2+

This list is currently the same as the x64 .NET Core 2.0 operating systems (see [.NET Core list](https://github.com/dotnet/core/blob/master/roadmap.md#net-core-20---supported-os-versions)). Note that other Linux distributions will likely work as well as long as they include glibc, OpenSSL 1.0, and libunwind.

### Found a Bug?
Please file any issues at https://github.com/OmniSharp/omnisharp-vscode/issues.

### Debugging
The C# extension now supports basic debugging capabilities! See http://aka.ms/vscclrdebugger for details.

### Development

First install:
* Node.js (newer than 4.3.1)
* Npm (newer 2.14.12)

To **run and develop** do the following:

* Run `npm i`
* Run `npm run compile`
* Open in Visual Studio Code (`code .`)
* *Optional:* run `npm run watch`, make code changes
* Press <kbd>F5</kbd> to debug

To **test** do the following: `npm run test` or <kbd>F5</kbd> in VS Code with the "Launch Tests" debug configuration.

### License
The Microsoft C# extension is subject to [these license terms](RuntimeLicenses/license.txt).
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).
Clean up readme a bit 2016-02-18 18:01:23 +03:00			`## C# for Visual Studio Code (powered by OmniSharp)`
Happy Coding! 2015-12-03 13:25:00 +03:00
Update readme.md for 1.4.0 2016-08-29 19:55:56 +03:00			`\|Master\|Release\|`
Tweak display of build status on readme 2016-03-24 05:33:57 +03:00			`\|:--:\|:--:\|`
Update readme.md for 1.4.0 2016-08-29 19:55:56 +03:00			`\|[![Master Build Status](https://travis-ci.org/OmniSharp/omnisharp-vscode.svg?branch=master)](https://travis-ci.org/OmniSharp/omnisharp-vscode)\|[![Release Build Status](https://travis-ci.org/OmniSharp/omnisharp-vscode.svg?branch=release)](https://travis-ci.org/OmniSharp/omnisharp-vscode)\|`
Add build to status to readme 2016-03-24 05:27:19 +03:00
Clean up readme and bump version number 2016-05-18 19:54:03 +03:00			`Welcome to the C# extension for Visual Studio Code! This preview provides the following features inside VS Code:`
updated readme (links to former extension and instructions) and adjusted debugger.md (mono, tasks.json) 2016-03-04 04:07:09 +03:00
Clean up readme and bump version number 2016-05-18 19:54:03 +03:00			`* Lightweight development tools for [.NET Core](https://dotnet.github.io).`
			`* Great C# editing support, including Syntax Highlighting, IntelliSense, Go to Definition, Find All References, etc.`
Update debugger support note 2016-05-18 21:45:27 +03:00			`* Debugging support for .NET Core (CoreCLR). NOTE: Mono and Desktop CLR debugging is not supported.`
Update readme for 1.5 2016-11-11 23:25:50 +03:00			`* Support for project.json and csproj projects on Windows, macOS and Linux.`
Update README.md to reference the OmniSharp extension 2016-05-16 20:16:03 +03:00
Clean up readme and bump version number 2016-05-18 19:54:03 +03:00			`The C# extension is powered by [OmniSharp](https://github.com/OmniSharp/omnisharp-roslyn).`
Update README.md to reference the OmniSharp extension 2016-05-16 20:16:03 +03:00
Update to 1.5.1 2016-11-15 01:43:27 +03:00			`### Get Started Writing C# in VS Code`
Update CHANGELOG.md, README.md and version number for v1.6.0 release 2016-12-21 22:30:38 +03:00
Add Get Started Section Added links to "Get Started" section to our documentation and my video tutorial with .NET Core. 2016-09-23 02:10:34 +03:00			`* [Documentation](https://code.visualstudio.com/docs/languages/csharp)`
Update old video link (#1928) 2017-12-31 18:34:43 +03:00			`* [Video Tutorial compiling with .NET Core](https://channel9.msdn.com/Blogs/dotnet/Get-started-VSCode-Csharp-NET-Core-Windows)`
Add Get Started Section Added links to "Get Started" section to our documentation and my video tutorial with .NET Core. 2016-09-23 02:10:34 +03:00
Update Readme 2018-02-15 00:08:19 +03:00			`### What's New in 1.14.0`

			`* Support for C# 7.2`
			`* Debugger support for extracting source files embedded in PDBs`
			`* Preliminary support for Linux ARM debugging`
			`* Improved Symbol/Documentation text display`
			`* Addressed problems with projects not being refreshed by OmniSharp after a package restore`
			`* Added option to disable warning about project.json deprecation`
Updates to README for 1.13 2017-11-07 19:31:31 +03:00			`* Many other bug fixes!`

Update Readme 2018-02-15 00:08:19 +03:00			`See our [change log](https://github.com/OmniSharp/omnisharp-vscode/blob/v1.14.0/CHANGELOG.md) for all of the updates.`
Update readme for 1.5 2016-11-11 23:25:50 +03:00
			`### Supported Operating Systems for Debugging`
Update readme.md for 1.3 2016-07-20 21:10:11 +03:00
Update debugger to 1.12.2 and support large set of Linux distros (#1576) * Update debugger to 1.12.0 and remove 'runtimeId' support This checkin updates the debugger to the 1.12.0 release. The major change here is that we are now running on .NET Core 2, and so we can use a single runtime id for all glibc-based Linux distros. This means we can remove all the support we have for runtime id detection and filtering. * Update debugger to 1.12.2 and update documentation This updates the debugger to 1.12.2, which among other things, uses .NET Core 2.0-preview2 instead of preview1. 2017-07-01 00:25:04 +03:00			`* Currently, the C# debugger officially supports the following operating systems:`
Update readme.md for 1.3 2016-07-20 21:10:11 +03:00
			`* Windows (64-bit only)`
Make changes to detect and require macOS Sierra (#1688) .NET Core 2.0 only supports Sierra, and it will fall over on older versions of macOS. This adds detection code to let users know what is going on. 2017-08-08 22:39:52 +03:00			`* macOS 10.12 (Sierra) and newer`
Update debugger to 1.12.2 and support large set of Linux distros (#1576) * Update debugger to 1.12.0 and remove 'runtimeId' support This checkin updates the debugger to the 1.12.0 release. The major change here is that we are now running on .NET Core 2, and so we can use a single runtime id for all glibc-based Linux distros. This means we can remove all the support we have for runtime id detection and filtering. * Update debugger to 1.12.2 and update documentation This updates the debugger to 1.12.2, which among other things, uses .NET Core 2.0-preview2 instead of preview1. 2017-07-01 00:25:04 +03:00			`* Ubuntu 14.04+ (and distros based on it)`
			`* Debian 8.7+`
			`* Red Hat Enterprise Linux (RHEL) / CentOS / Oracle Linux 7.3+`
			`* Fedora 23 / 24 / 25`
			`* OpenSUSE 42.2+`

			`This list is currently the same as the x64 .NET Core 2.0 operating systems (see [.NET Core list](https://github.com/dotnet/core/blob/master/roadmap.md#net-core-20---supported-os-versions)). Note that other Linux distributions will likely work as well as long as they include glibc, OpenSSL 1.0, and libunwind.`
Clean up readme and bump version number 2016-05-18 19:54:03 +03:00
			`### Found a Bug?`
			`Please file any issues at https://github.com/OmniSharp/omnisharp-vscode/issues.`
Update README.md to reference the OmniSharp extension 2016-05-16 20:16:03 +03:00
updated readme (links to former extension and instructions) and adjusted debugger.md (mono, tasks.json) 2016-03-04 04:07:09 +03:00			`### Debugging`
Clean up readme and bump version number 2016-05-18 19:54:03 +03:00			`The C# extension now supports basic debugging capabilities! See http://aka.ms/vscclrdebugger for details.`
Update readme and labels 2015-12-07 11:37:18 +03:00
updated readme (links to former extension and instructions) and adjusted debugger.md (mono, tasks.json) 2016-03-04 04:07:09 +03:00			`### Development`
Update development guide 2016-05-18 00:56:20 +03:00
			`First install:`
			`* Node.js (newer than 4.3.1)`
			`* Npm (newer 2.14.12)`
Added a tip in the README for people who don't have node-gyp set-up yet and will see an error when installing the vscode-textmate regex dependency. 2016-09-23 23:34:57 +03:00
Happy Coding! 2015-12-03 13:25:00 +03:00			`To run and develop do the following:`

Clean up readme a bit 2016-02-18 18:01:23 +03:00			* Run `npm i`
Update readme for 1.5 2016-11-11 23:25:50 +03:00			* Run `npm run compile`
Clean up readme a bit 2016-02-18 18:01:23 +03:00			* Open in Visual Studio Code (`code .`)
Clarify and shorten watch NPM task description The `tsc` can be run from already defined NPM script and by this: - no local installation is needed for compiler - the long path for Windows OS command is no longer required Usage: npm run watch > csharp@1.8.0 watch /Users/piotrblazejewicz/git/omnisharp-vscode > tsc -watch -p ./ 3:19:52 PM - Compilation complete. Watching for file changes. ... Thanks! 2017-03-17 17:21:26 +03:00			* Optional: run `npm run watch`, make code changes
Update readme.md for 1.4.0 2016-08-29 19:55:56 +03:00			`* Press <kbd>F5</kbd> to debug`
Update licenses for the C# extension This commit addresses issue #42 and other licensing concerns -- 1. Update the readme to reference licensing 2. Change the package.json to reference the EULA rather than the source license. 3. Checkin the OpenDebugAD7 license so that it has a home on the web. Needed for its nuget package. 2016-03-03 02:57:31 +03:00
Tweaks to readme for 1.7 2017-02-08 04:50:00 +03:00			To test do the following: `npm run test` or <kbd>F5</kbd> in VS Code with the "Launch Tests" debug configuration.
Added a tip in the README for people who don't have node-gyp set-up yet and will see an error when installing the vscode-textmate regex dependency. 2016-09-23 23:34:57 +03:00
Clean up readme and bump version number 2016-05-18 19:54:03 +03:00			`### License`
Added a tip in the README for people who don't have node-gyp set-up yet and will see an error when installing the vscode-textmate regex dependency. 2016-09-23 23:34:57 +03:00			`The Microsoft C# extension is subject to [these license terms](RuntimeLicenses/license.txt).`
			`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).`