vscode/README.md

60 lines
4.3 KiB
Markdown
Raw Normal View History

2017-04-11 07:51:50 +00:00
# Visual Studio Code - Open Source
2015-11-14 17:06:03 +00:00
2018-09-10 15:28:29 +00:00
[![Build Status](https://vscode.visualstudio.com/_apis/public/build/definitions/a4cdce18-a05c-4bb8-9476-5d07e63bfd76/1/badge?branchName=master)](https://aka.ms/vscode-builds)
2018-09-12 07:56:04 +00:00
[![Feature Requests](https://img.shields.io/github/issues/Microsoft/vscode/feature-request.svg)](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc)
2018-09-10 16:03:48 +00:00
[![Bugs](https://img.shields.io/github/issues/Microsoft/vscode/bug.svg)](https://github.com/Microsoft/vscode/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Abug)
2018-10-14 17:59:38 +00:00
[![Gitter](https://img.shields.io/badge/chat-on%20gitter-yellow.svg)](https://gitter.im/Microsoft/vscode)
2015-11-19 17:28:05 +00:00
2018-10-26 01:20:10 +00:00
[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.
2015-11-14 17:06:03 +00:00
2018-10-26 01:20:10 +00:00
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.
2015-11-19 09:52:00 +00:00
<p align="center">
<img alt="VS Code in action" src="https://cloud.githubusercontent.com/assets/11839736/16642200/6624dde0-43bd-11e6-8595-c81885ba0dc2.png">
2015-11-19 09:52:00 +00:00
</p>
2019-01-22 15:08:28 +00:00
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:
* [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.
2015-11-17 15:29:10 +00:00
## Contributing
2016-12-20 20:41:42 +00:00
2016-03-01 17:28:47 +00:00
If you are interested in fixing issues and contributing directly to the code base,
2016-04-22 19:54:32 +00:00
please see the document [How to Contribute](https://github.com/Microsoft/vscode/wiki/How-to-Contribute), which covers the following:
2015-11-16 14:14:58 +00:00
2018-10-07 15:32:45 +00:00
* [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)
2016-04-22 19:54:32 +00:00
* [Coding Guidelines](https://github.com/Microsoft/vscode/wiki/Coding-Guidelines)
* [Submitting pull requests](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#pull-requests)
2017-10-24 08:34:58 +00:00
* [Contributing to translations](https://aka.ms/vscodeloc)
2015-11-16 14:14:58 +00:00
2018-10-15 18:56:35 +00:00
Please also see our [Code of Conduct](CODE_OF_CONDUCT.md).
2016-06-22 08:39:24 +00:00
2016-02-09 01:36:44 +00:00
## Feedback
* Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode).
* Request a new feature on [GitHub](CONTRIBUTING.md).
2018-10-17 22:51:43 +00:00
* Vote for [Popular Feature Requests](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc).
2016-04-15 07:15:36 +00:00
* File a bug in [GitHub Issues](https://github.com/Microsoft/vscode/issues).
2018-10-26 01:20:10 +00:00
* [Tweet](https://twitter.com/code) us with any other feedback.
2016-02-09 01:36:44 +00:00
2015-11-17 15:29:10 +00:00
## 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.
2015-11-16 14:14:58 +00:00
2018-10-17 22:51:43 +00:00
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.
2015-11-17 15:29:10 +00:00
## License
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the [MIT](LICENSE.txt) License.