forked from microsoft/vscode
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
clean up the readme (microsoft#74293)
* Tidy up the readme, update graphic
- Loading branch information
Showing
3 changed files
with
37 additions
and
27 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,68 @@ | ||
| # Visual Studio Code - Open Source | ||
| # Visual Studio Code - Open Source ("Code - OSS") | ||
|
|
||
| <!-- [](https://aka.ms/vscode-builds) --> | ||
| [](https://dev.azure.com/vscode/VSCode/_build/latest?definitionId=12) | ||
| [](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) | ||
| [](https://github.com/Microsoft/vscode/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Abug) | ||
| [](https://gitter.im/Microsoft/vscode) | ||
|
|
||
| [VS Code](https://code.visualstudio.com) is a type of tool that combines the simplicity of | ||
| a code editor with what developers need for their core edit-build-debug cycle. It provides comprehensive editing and debugging support, an extensibility model, and lightweight integration with existing tools. | ||
| ## The Repository | ||
|
|
||
| VS Code is updated monthly with new features and bug fixes. You can download it for Windows, macOS, and Linux on [VS Code's website](https://code.visualstudio.com/Download). To get the latest releases every day, you can install the [Insiders version of VS Code](https://code.visualstudio.com/insiders). This builds from the master branch and is updated daily at the very least. | ||
| This repository ("`Code - OSS`") is where we (Microsoft) develop the [Visual Studio Code](https://code.visualstudio.com) product. Not only do we work on code and issues here, we also publish our roadmap, monthly iteration plans, and our endgame plans. The source code here is available to everyone under the standard [MIT license](https://github.com/microsoft/vscode/blob/master/LICENSE.txt). | ||
|
|
||
| ## Visual Studio Code | ||
|
|
||
| <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://user-images.githubusercontent.com/1487073/58344409-70473b80-7e0a-11e9-8570-b2efc6f8fa44.png"> | ||
| </p> | ||
|
|
||
| The [`vscode`](https://github.com/microsoft/vscode) repository is where VS Code is developed and there are many ways in which you can participate in the project, for example: | ||
| [Visual Studio Code](https://code.visualstudio.com) is a distribution of the `Code - OSS` repository with Microsoft specific customizations released under a traditional [Microsoft product license](https://code.visualstudio.com/License/). | ||
|
|
||
| [Visual Studio Code](https://code.visualstudio.com) combines the simplicity of a code editor with what developers need for their core edit-build-debug cycle. It provides comprehensive code editing, navigation, and understanding support along with lightweight debugging, a rich extensibility model, and lightweight integration with existing tools. | ||
|
|
||
| Visual Studio Code is updated monthly with new features and bug fixes. You can download it for Windows, macOS, and Linux on [Visual Studio Code's website](https://code.visualstudio.com/Download). To get the latest releases every day, install the [Insiders build](https://code.visualstudio.com/insiders). | ||
|
|
||
|
|
||
| * [Submit bugs and feature requests](https://github.com/microsoft/vscode/issues) and help us verify as they are checked in. | ||
| * Review [source code changes](https://github.com/microsoft/vscode/pulls). | ||
| * Review the [documentation](https://github.com/microsoft/vscode-docs) and make pull requests for anything from typos to new content. | ||
|
|
||
| ## Contributing | ||
|
|
||
| There are many ways in which 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 | ||
| * Review [source code changes](https://github.com/microsoft/vscode/pulls) | ||
| * Review the [documentation](https://github.com/microsoft/vscode-docs) and make pull requests for anything from typos to new content | ||
|
|
||
| If you are interested in fixing issues and contributing directly to the code base, | ||
| please see the document [How to Contribute](https://github.com/Microsoft/vscode/wiki/How-to-Contribute), which covers the following: | ||
|
|
||
| * [How to build and run from source](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run) | ||
| * [The development workflow, including debugging and running tests](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#debugging) | ||
| * [Coding Guidelines](https://github.com/Microsoft/vscode/wiki/Coding-Guidelines) | ||
| * [Coding guidelines](https://github.com/Microsoft/vscode/wiki/Coding-Guidelines) | ||
| * [Submitting pull requests](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#pull-requests) | ||
| * [Contributing to translations](https://aka.ms/vscodeloc) | ||
|
|
||
| Please also see our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
|
||
| ## Feedback | ||
|
|
||
| * Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode). | ||
| * Request a new feature on [GitHub](CONTRIBUTING.md). | ||
| * Vote for [Popular Feature Requests](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc). | ||
| * File a bug in [GitHub Issues](https://github.com/Microsoft/vscode/issues). | ||
| * [Tweet](https://twitter.com/code) us with any other feedback. | ||
| * Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode) | ||
| * [Request a new feature](CONTRIBUTING.md) | ||
| * Up vote [popular feature requests](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) | ||
| * [File an issue](https://github.com/Microsoft/vscode/issues) | ||
| * Follow [@code](https://twitter.com/code) and let us know what you think! | ||
|
|
||
| ## 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) have their own repositories. | ||
|
|
||
| For a complete list, please visit the [Related Projects](https://github.com/Microsoft/vscode/wiki/Related-Projects) page on our [wiki](https://github.com/Microsoft/vscode/wiki). | ||
| 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) have their own repositories. For a complete list, please visit the [Related Projects](https://github.com/Microsoft/vscode/wiki/Related-Projects) page on our [wiki](https://github.com/Microsoft/vscode/wiki). | ||
|
|
||
| ## Bundled Extensions | ||
|
|
||
| Code ships with a set of extensions. These extensions are located in the [extensions](extensions) folder. | ||
| These extensions include grammars and snippets for several languages. Extensions that provide rich language support (code completion, go to definition) for a language have the suffix 'language-features'. For example, the 'json' extension provides coloring for JSON and the 'json-language-features' provides rich language support for JSON. | ||
| Code includes a set of built-in extensions located in the [extensions](extensions) folder, including grammars and snippets for many languages. Extensions that provide rich language support (code completion, Go to Definition) for a language have the suffix `language-features`. For example, the `json` extension provides coloring for `JSON` and the `json-language-features` provides rich language support for `JSON`. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| ## License | ||
|
|
||
| Copyright (c) Microsoft Corporation. All rights reserved. | ||
|
|
||
| Licensed under the [MIT](LICENSE.txt) License. | ||
| Licensed under the [MIT](LICENSE.txt) license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -154,7 +154,8 @@ To connect to the server from NodeJS, see Remy Suen's great write-up on [how to | |
|
|
||
| ## Participate | ||
|
|
||
| The source code of the JSON language server can be found [VSCode repository](https://github.com/Microsoft/vscode) at [extensions/json-language-features/server](https://github.com/Microsoft/vscode/tree/master/extensions/json-language-features/server). | ||
| The source code of the JSON language server can be found in the [VSCode repository](https://github.com/Microsoft/vscode) at [extensions/json-language-features/server](https://github.com/Microsoft/vscode/tree/master/extensions/json-language-features/server). | ||
|
|
||
| File issues and pull requests in the [VSCode GitHub Issues](https://github.com/Microsoft/vscode/issues). See the document [How to Contribute](https://github.com/Microsoft/vscode/wiki/How-to-Contribute) on how to build and run from source. | ||
|
|
||
| Most of the functionality of the server is located in libraries: | ||
|
|
@@ -164,10 +165,12 @@ Most of the functionality of the server is located in libraries: | |
|
|
||
| Help on any of these projects is very welcome. | ||
|
|
||
| Please see also our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| ## License | ||
|
|
||
| Copyright (c) Microsoft Corporation. All rights reserved. | ||
|
|
||
| Licensed under the [MIT](LICENSE.txt) License. | ||
| Licensed under the [MIT](https://github.com/microsoft/vscode/blob/master/LICENSE.txt) License. | ||