|
1 | | -# Visual Studio Code - Open Source ("Code - OSS") |
2 | | -[](https://github.com/microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) |
3 | | -[](https://github.com/microsoft/vscode/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Abug) |
4 | | -[](https://gitter.im/Microsoft/vscode) |
| 1 | +# VS Code Web Server |
5 | 2 |
|
6 | | -## The Repository |
| 3 | +[](https://gitpod.io/from-referrer/) |
7 | 4 |
|
8 | | -This repository ("`Code - OSS`") is where we (Microsoft) develop the [Visual Studio Code](https://code.visualstudio.com) product together with the community. Not only do we work on code and issues here, we also publish our [roadmap](https://github.com/microsoft/vscode/wiki/Roadmap), [monthly iteration plans](https://github.com/microsoft/vscode/wiki/Iteration-Plans), and our [endgame plans](https://github.com/microsoft/vscode/wiki/Running-the-Endgame). This source code is available to everyone under the standard [MIT license](https://github.com/microsoft/vscode/blob/main/LICENSE.txt). |
| 5 | +## What is this? |
9 | 6 |
|
10 | | -## Visual Studio Code |
| 7 | +This project provides a version of VS Code that runs a server on a remote machine and allows through a modern web browsers. It's based on the very same architecture used by [Gitpod](https://www.gitpod.io) or [GitHub Codespaces](https://github.com). |
11 | 8 |
|
12 | | -<p align="center"> |
13 | | - <img alt="VS Code in action" src="https://user-images.githubusercontent.com/35271042/118224532-3842c400-b438-11eb-923d-a5f66fa6785a.png"> |
14 | | -</p> |
| 9 | +<img width="1624" alt="Screenshot 2021-09-02 at 08 39 26" src="https://user-images.githubusercontent.com/372735/131794918-d6602646-4d67-435b-88fe-620a3cc0a3aa.png"> |
15 | 10 |
|
16 | | -[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/). |
| 11 | +## Why? |
17 | 12 |
|
18 | | -[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. |
| 13 | +VS Code has traditionally been a desktop IDE built with web-technology. A few years back people started patching it, in order to run it in a remote context and to make it accessible through web browsers. [These efforts have been a complex and error prone](https://github.com/cdr/code-server/issues/3835), because many changes had to be made across the large code base of VS Code. |
19 | 14 |
|
20 | | -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). |
| 15 | +Luckily in 2019 the Vs Code team started to refactor its architecture to support this working mode. While this new architecture has been adopted by Gitpod and GitHub, the important bits have not been open-sources, yet. As a result many people in the community are still using the old hard to maintain and errorprone approach. |
21 | 16 |
|
22 | | -## Contributing |
| 17 | +At Gitpod we've been asked a lot about how we do it. So we thought we might just share the minimal set of changes needed, so people can rely on the latest version of VS Code and have a straight forward upgrade path and low maintenance effort. |
23 | 18 |
|
24 | | -There are many ways in which you can participate in this project, for example: |
| 19 | +## Getting started |
25 | 20 |
|
26 | | -* [Submit bugs and feature requests](https://github.com/microsoft/vscode/issues), and help us verify as they are checked in |
27 | | -* Review [source code changes](https://github.com/microsoft/vscode/pulls) |
28 | | -* Review the [documentation](https://github.com/microsoft/vscode-docs) and make pull requests for anything from typos to additional and new content |
| 21 | +The easiest way to get started is ... |
29 | 22 |
|
30 | | -If you are interested in fixing issues and contributing directly to the code base, |
31 | | -please see the document [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute), which covers the following: |
| 23 | +## The scope of this project |
32 | 24 |
|
33 | | -* [How to build and run from source](https://github.com/microsoft/vscode/wiki/How-to-Contribute) |
34 | | -* [The development workflow, including debugging and running tests](https://github.com/microsoft/vscode/wiki/How-to-Contribute#debugging) |
35 | | -* [Coding guidelines](https://github.com/microsoft/vscode/wiki/Coding-Guidelines) |
36 | | -* [Submitting pull requests](https://github.com/microsoft/vscode/wiki/How-to-Contribute#pull-requests) |
37 | | -* [Finding an issue to work on](https://github.com/microsoft/vscode/wiki/How-to-Contribute#where-to-contribute) |
38 | | -* [Contributing to translations](https://aka.ms/vscodeloc) |
| 25 | +This project really only adds the minimal bits required to run VS Code in a web server scenario. We have no intention of changing VS Code in any way or adding additional features through this. Feature request, bug fixes, etc. should go to the upstream repository. |
39 | 26 |
|
40 | | -## Feedback |
41 | | - |
42 | | -* Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode) |
43 | | -* [Request a new feature](CONTRIBUTING.md) |
44 | | -* Upvote [popular feature requests](https://github.com/microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) |
45 | | -* [File an issue](https://github.com/microsoft/vscode/issues) |
46 | | -* Follow [@code](https://twitter.com/code) and let us know what you think! |
47 | | - |
48 | | -See our [wiki](https://github.com/microsoft/vscode/wiki/Feedback-Channels) for a description of each of these channels and information on some other available community-driven channels. |
49 | | - |
50 | | -## Related Projects |
51 | | - |
52 | | -Many of the core components and extensions to VS 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). |
53 | | - |
54 | | -## Bundled Extensions |
55 | | - |
56 | | -VS 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`. |
57 | | - |
58 | | -## Development Container |
59 | | - |
60 | | -This repository includes a Visual Studio Code Remote - Containers / GitHub Codespaces development container. |
61 | | - |
62 | | -- For [Remote - Containers](https://aka.ms/vscode-remote/download/containers), use the **Remote-Containers: Clone Repository in Container Volume...** command which creates a Docker volume for better disk I/O on macOS and Windows. |
63 | | -- For Codespaces, install the [Github Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension in VS Code, and use the **Codespaces: Create New Codespace** command. |
64 | | - |
65 | | -Docker / the Codespace should have at least **4 Cores and 6 GB of RAM (8 GB recommended)** to run full build. See the [development container README](.devcontainer/README.md) for more information. |
66 | | - |
67 | | -## Code of Conduct |
68 | | - |
69 | | -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. |
70 | | - |
71 | | -## License |
72 | | - |
73 | | -Copyright (c) Microsoft Corporation. All rights reserved. |
74 | | - |
75 | | -Licensed under the [MIT](LICENSE.txt) license. |
| 27 | +> **For any feature requests, bug reports, or contributions that are not specific to running VS Code in a web server context,** |
| 28 | +> |
| 29 | +> **please go to [Visual Studio Code - Open Source "OSS"](https://github.com/microsoft/vscode)** |
0 commit comments