Skip to content

Commit

Permalink
Clarifying README
Browse files Browse the repository at this point in the history
Clarifying product name and its licensing.
Related to microsoft#60, microsoft#1230, microsoft#2982, microsoft#3029, microsoft#5342, microsoft#17996.
Based on @chrisdias [comment](microsoft#2983 (comment)) and [comment](microsoft#60 (comment))
  • Loading branch information
slodki committed Jun 14, 2017
1 parent 24090b6 commit e3a3194
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions README.md
@@ -1,20 +1,23 @@
# Visual Studio Code - Open Source # Code - Open Source


[![Build Status](https://travis-ci.org/Microsoft/vscode.svg?branch=master)](https://travis-ci.org/Microsoft/vscode) [![Build Status](https://travis-ci.org/Microsoft/vscode.svg?branch=master)](https://travis-ci.org/Microsoft/vscode)
[![Build Status](https://ci.appveyor.com/api/projects/status/vuhlhg80tj3e2a0l/branch/master?svg=true)](https://ci.appveyor.com/project/VSCode/vscode) [![Build Status](https://ci.appveyor.com/api/projects/status/vuhlhg80tj3e2a0l/branch/master?svg=true)](https://ci.appveyor.com/project/VSCode/vscode)
[![Coverage Status](https://img.shields.io/coveralls/Microsoft/vscode/master.svg)](https://coveralls.io/github/Microsoft/vscode?branch=master) [![Coverage Status](https://img.shields.io/coveralls/Microsoft/vscode/master.svg)](https://coveralls.io/github/Microsoft/vscode?branch=master)
[![Gitter](https://img.shields.io/badge/chat-on%20gitter-blue.svg)](https://gitter.im/Microsoft/vscode) [![Gitter](https://img.shields.io/badge/chat-on%20gitter-blue.svg)](https://gitter.im/Microsoft/vscode)


[VS Code](https://code.visualstudio.com) is a new type of tool that combines the simplicity of Code is a new type of tool that combines the simplicity of
a code editor with what developers need for their core edit-build-debug cycle. Code a code editor with what developers need for their core edit-build-debug cycle. Code
provides comprehensive editing and debugging support, an extensibility model, and lightweight integration with existing tools. provides comprehensive editing and debugging support, an extensibility model, and lightweight integration with existing tools.


VS Code is updated monthly with new features and bug fixes. You can download it for Windows, Mac and Linux on [VS Code's website](https://code.visualstudio.com/Download). To get the latest releases everyday, you can install the [Insiders version of VS Code](https://code.visualstudio.com/insiders). This builds from the master branch and is updated at least daily.

<p align="center"> <p align="center">
<img alt="VS Code in action" src="https://cloud.githubusercontent.com/assets/11839736/16642200/6624dde0-43bd-11e6-8595-c81885ba0dc2.png"> <img alt="VS Code in action" src="https://cloud.githubusercontent.com/assets/11839736/16642200/6624dde0-43bd-11e6-8595-c81885ba0dc2.png">
</p> </p>


Code is updated monthly with new features and bug fixes.
You can download sources of released versions from [GitHub Releases](https://github.com/Microsoft/vscode/releases).
Building binaries for Windows, OS X and Linux [instructions](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run-from-source)
are avaiable, but precompiled packages are not distributed here (see Related Products below).

The [`vscode`](https://github.com/microsoft/vscode) repository is where we do development and there are many ways you can participate in the project, for example: The [`vscode`](https://github.com/microsoft/vscode) repository is where we do development and there are many ways you can participate in the project, for example:


* [Submit bugs and feature requests](https://github.com/microsoft/vscode/issues) and help us verify as they are checked in * [Submit bugs and feature requests](https://github.com/microsoft/vscode/issues) and help us verify as they are checked in
Expand All @@ -41,6 +44,20 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
* File a bug in [GitHub Issues](https://github.com/Microsoft/vscode/issues). * File a bug in [GitHub Issues](https://github.com/Microsoft/vscode/issues).
* [Tweet](https://twitter.com/code) us with other feedback. * [Tweet](https://twitter.com/code) us with other feedback.


## Related Products
Microsoft is distributing its own build as Microsoft Visual Studio Code.
You can download packages for Windows, Mac and Linux on [VS Code's website](https://code.visualstudio.com/Download).

It's based on Code Open Source with some changes:
* Microsoft branding
* licensed under Microsoft [closed source custom product license](https://code.visualstudio.com/License) (EULA)
* Extension Marketplace supported
* crash reporting and telemetry enabled
* user configuration and extensions stored in different directory then Code - Open Source
* extension debugging supported

To get the latest releases everyday, you can install the [Insiders version of VS Code](https://code.visualstudio.com/insiders). This builds from the master branch and is updated at least daily.

## Related Projects ## Related Projects
Many of the core components and extensions to Code live in their own repositories on GitHub. For example, the [node debug adapter](https://github.com/microsoft/vscode-node-debug) and the [mono debug adapter](https://github.com/microsoft/vscode-mono-debug). Many of the core components and extensions to Code live in their own repositories on GitHub. For example, the [node debug adapter](https://github.com/microsoft/vscode-node-debug) and the [mono debug adapter](https://github.com/microsoft/vscode-mono-debug).


Expand Down

1 comment on commit e3a3194

@maelvls
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The paragraph on the "Microsoft-flavoured build" is a great idea. At least, people can understand how far Microsoft wants to get into "open-source".

Please sign in to comment.