You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
VS Code is a new choice of tool that combines the simplicity of a
4
-
code editor with what developers need for their core
5
-
edit-build-debug cycle. It is the first editor and first cross platform
6
-
tool in the Visual Studio family of products.
3
+
VS Code is a new choice of tool that combines the simplicity of a code editor with what developers need for their core edit-build-debug cycle. It is the first editor and first cross platform tool in the Visual Studio family of products.
7
4
8
-
Code incorporates Visual Studio's world class editing and debugging experiences
9
-
whlie integrating with existing tools. A rich extensibility model and
10
-
ecosystem provides support for a broad array of languages and tools that
11
-
integrate seamlessly with Code.
5
+
Code incorporates Visual Studio's world class editing and debugging experiences whlie integrating with your existing tool chain. A rich extensibility model and ecosystem provides support for a broad array of languages and tools that integrate seamlessly with Code.
12
6
13
-
The VSCode repository is where the Code team does development. We
14
-
encourage you to follow along, take part in the discussion, submit
15
-
issues, suggest a feature, or create a pull request!
7
+
The VSCode repository is where the Code team does development. We encourage you to follow along, take part in the discussion, submit issues, suggest a feature, or create a pull request!
16
8
17
9
Follow us [@code](https://twitter.com/code).
18
10
19
11
## Installation and Documentation
20
-
Download the latest build for your platform from the
21
-
[Visual Studio Code](http://code.visualstudio.com) website. Once
22
-
installed, Code will automatically update itself when we publish
23
-
new releases.
12
+
Download the latest build for your platform from the [Visual Studio Code](http://code.visualstudio.com) website. Once installed, Code will automatically update itself when we publish new releases.
24
13
25
-
Everything you need to know about using and extending Code can be
26
-
found in our online [documentation](http://code.visualstudio.com/docs).
27
-
Found a typo? Want to clarify something? Clone the
Everything you need to know about using and extending Code can be found in our online [documentation](http://code.visualstudio.com/docs). Found a typo? Want to clarify something? Clone the [vscode-docs](https://github.com/microsoft/vscode-docs) repository and make a pull request.
30
15
31
16
## Contributing
32
17
33
18
There are many ways to contribute to the Code project. For example:
34
19
35
-
*[Submit bugs](https://github.com/microsoft/vscode/issues) and help
36
-
us verify fixes as they are checked in
20
+
*[Submit bugs](https://github.com/microsoft/vscode/issues) and help us verify fixes as they are checked in
* Engage with users and other developers on [Stack Overflow](http://go.microsoft.com/fwlink/?LinkID=536384)
39
23
*[Fix a bug and make a pull request](https://github.com/Microsoft/vscode/wiki/How-to-Contribute)
40
-
* Review the [documentation](https://github.com/microsoft/vscode-docs)
41
-
and make pull requests for anything from typos to new content
24
+
* Review the [documentation](https://github.com/microsoft/vscode-docs) and make pull requests for anything from typos to new content
42
25
43
26
Check out [How to Contribute](https://github.com/Microsoft/vscode/wiki) for more information.
44
27
45
28
## Build and Run From Source
46
29
47
-
If you want to understand how Code works or want to debug an issue, you'll want to get the source,
48
-
build it, and run the tool locally.
30
+
If you want to understand how Code works or want to debug an issue, you'll want to get the source, build it, and run the tool locally.
49
31
50
32
### Installing Prerequisites
51
33
52
34
[Download the latest version](https://code.visualstudio.com/Download) of Visual Studio Code (you will use Code to edit Code!)
53
35
54
-
VS Code includes node module dependencies that require native compilation. To ensure the compilation is picking up the right version of
55
-
header files from the Electron Shell, we have our own script to run the installation via npm (`scripts/npm`).
36
+
VS Code includes node module dependencies that require native compilation. To ensure the compilation is picking up the right version of header files from the Electron Shell, we have our own script to run the installation via npm (`scripts/npm`).
56
37
57
-
**Tip!** In case you fail to build the native modules you can copy the node_modules folder of the VS Code installation
58
-
into the VSCode workspaces node_modules folder. You will still need to run `scripts/npm install` to get all the development dependencies installed.
38
+
**Tip!** In case you fail to build the native modules you can copy the node_modules folder of the VS Code installation into the VSCode workspaces node_modules folder. You will still need to run `scripts/npm install` to get all the development dependencies installed.
59
39
60
40
For native compilation, you will need python (version `v2.7` recommended, `v3.x.x` is __*not*__ supported) as well as a C/C++ compiler tool chain.
61
41
62
42
**Windows:**
63
43
* In addition to Python v2.7, make sure you have a PYTHON environment variable set to `drive:\path\to\python.exe`, not to a folder
64
-
* Visual Studio 2013 for Windows Desktop or [Visual Studio 2015](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)
65
-
, make sure to select the option to install all C++ tools and the Windows SDK
44
+
* Visual Studio 2013 for Windows Desktop or [Visual Studio 2015](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx) , make sure to select the option to install all C++ tools and the Windows SDK
66
45
67
46
**OS X** Command line developer tools
68
47
* Python should be installed already
69
-
*[XCode](https://developer.apple.com/xcode/downloads/) and the Command Line Tools (XCode -> Preferences -> Downloads), which will
70
-
install `gcc` and the related toolchain containing `make`
48
+
*[XCode](https://developer.apple.com/xcode/downloads/) and the Command Line Tools (XCode -> Preferences -> Downloads), which will install `gcc` and the related toolchain containing `make`
71
49
72
50
**Linux:**
73
51
* Python v2.7
@@ -100,23 +78,15 @@ Linux
100
78
## Development Workflow
101
79
102
80
### Incremental Build
103
-
Open VS Code on the folder where you have cloned the vscode repository and press
104
-
`CTRL+SHIFT+B` on Windows or `COMMAND+SHIFT+B` on OSX to start the TypeScript
105
-
builder. It will do an initial full build and then watch for file changes, compiling
106
-
those changes *incrementally*. To view the build output open the Output stream by pressing `Shift+CMD+U`.
81
+
Open VS Code on the folder where you have cloned the vscode repository and press `CTRL+SHIFT+B` on Windows or `COMMAND+SHIFT+B` on OSX to start the TypeScript builder. It will do an initial full build and then watch for file changes, compiling those changes *incrementally*. To view the build output open the Output stream by pressing `Shift+CMD+U`.
107
82
108
83
### Errors and Warnigns
109
-
Errors and warnings are indicated in the status bar at the bottom left. You can
110
-
view the error list using `View | Errors and Warnings` or pressing `CMD+P` and then `!`.
111
-
Please note, if you start the TypeScript builder from a terminal using `gulp watch`, errors
112
-
and warnings will only show in the console and not in Code.
84
+
Errors and warnings are indicated in the status bar at the bottom left. You can view the error list using `View | Errors and Warnings` or pressing `CMD+P` and then `!`. Please note, if you start the TypeScript builder from a terminal using `gulp watch`, errors and warnings will only show in the console and not in Code.
113
85
114
-
**Tip!** You do not need to stop and restart the development version after each change,
115
-
you can just execute `Reload Window` from the command palette.
86
+
**Tip!** You do not need to stop and restart the development version after each change, you can just execute `Reload Window` from the command palette.
116
87
117
88
### Validate your changes
118
-
To test the changes you launch a development version of VS Code on the workspace
119
-
`vscode`, which youare currently editing.
89
+
To test the changes you launch a development version of VS Code on the workspace `vscode`, which youare currently editing.
120
90
121
91
OS X and Linux
122
92
@@ -128,19 +98,13 @@ Windows
128
98
129
99
You can identify the development version of Code by the Electron icon in the Dock or Taskbar.
130
100
131
-
**Tip!** If you receive an error stating that the app is not a valid Electron app, it probably
132
-
means you didn't run `gulp watch` first.
101
+
**Tip!** If you receive an error stating that the app is not a valid Electron app, it probably means you didn't run `gulp watch` first.
133
102
134
103
### Debugging
135
104
Code has a multi-process architecture and your code is executed in different processes:
136
-
* The **render** process runs the UI code inside the Shell window. To debug code running in the **renderer** process, launch the Chrome Developers Tools
137
-
using the `Developer: Toggle Developer Tools` command from the Command Palette.
105
+
* The **render** process runs the UI code inside the Shell window. To debug code running in the **renderer** process, launch the Chrome Developers Tools using the `Developer: Toggle Developer Tools` command from the Command Palette.
138
106
139
-
* The **extension host** process runs code implemented by a plugin. To debug extensions (including those packaged with code) which run in the **extension host**
140
-
process, you can use VS Code itself. Switch to the Debug viewlet, choose the
141
-
`Attach to Extension Host` configuration, and press `F5`.
107
+
* The **extension host** process runs code implemented by a plugin. To debug extensions (including those packaged with code) which run in the **extension host** process, you can use VS Code itself. Switch to the Debug viewlet, choose the `Attach to Extension Host` configuration, and press `F5`.
142
108
143
109
### Unit Testing
144
-
Press `SHIFT+CMD+T` (`CTRL+SHIFT+T` on Windows) to start the unit tests or run the tests directly
145
-
from a terminal by running `mocha` from the `vscode` folder. The [/test README](test/README.md) has complete details on
146
-
how to run and debug tests, as well as how to produce coverage reports.
110
+
Press `SHIFT+CMD+T` (`CTRL+SHIFT+T` on Windows) to start the unit tests or run the tests directly from a terminal by running `mocha` from the `vscode` folder. The [/test README](test/README.md) has complete details on how to run and debug tests, as well as how to produce coverage reports.
0 commit comments