|
1 | | -# Microclimate Developer Tools for VSCode |
| 1 | +# Microclimate Developer Tools for VS Code |
2 | 2 |
|
3 | | -Welcome to Microclimate Developer Tools for VSCode! |
| 3 | +You can use [Microclimate Developer Tools for Visual Studio Code](https://github.com/microclimate-dev2ops/microclimate-vscode-tools) to develop your [Microclimate](https://microclimate-dev2ops.github.io) projects from within VS Code. Use the tools to access Microclimate features in the comfort of your IDE. |
4 | 4 |
|
5 | | -This is the README that is packaged into our extension. |
| 5 | +Join us [on Slack](https://slack-invite-ibm-cloud-tech.mybluemix.net) if you have any questions. |
6 | 6 |
|
7 | | -## How to install |
8 | | -1. [Download the newest build from the build branch](https://github.ibm.com/dev-ex/microclimate-vscode/raw/build/vscode-microclimate-tools-0.0.2.vsix) |
9 | | -2. In VSCode, go `View` > `Extensions` > `...` overflow menu > `Install from VSIX...` |
| 7 | +## How to install [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-getting-started) |
10 | 8 |
|
11 | | -## How to use |
12 | | -- Open the Microclimate Projects view within the Explorer view group (`Ctrl/Cmd + Shift + E`), |
13 | | - - Right-click to create a default local connection. |
14 | | - - Right-click a project to see the actions available (see below) |
15 | | -- Open the Command Pallete (`Ctrl/Cmd + Shift + P`) and type "Microclimate" to see the actions available |
| 9 | +1. Install [VS Code version 1.27 or later](https://code.visualstudio.com/download) and [local Microclimate version 18.12 or later](https://microclimate-dev2ops.github.io/installlocally). |
| 10 | +2. Install Microclimate Developer Tools for VS Code from the [VS Code Marketplace](https://marketplace.visualstudio.com/VSCode) or by searching for "Microclimate" in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions). |
16 | 11 |
|
17 | | -## Features |
18 | | -- View all projects in Microclimate, including their app and build statuses |
19 | | - - No linking required |
20 | | - - All projects are always visible, and the list updates automatically |
21 | | -- Debug **Microprofile, Spring, and Node** Microclimate projects |
22 | | -- Integrate Microclimate validation errors into the VSCode Problems view |
23 | | -- Open a shell session into a Microclimate application container |
24 | | -- View project info (similar to Microclimate Overview page) |
25 | | -- Toggle project auto-build |
26 | | -- Easily scope your VSCode workspace to a Microclimate project or your `microclimate-workspace` |
27 | | -- Open applications in system browser |
28 | | -- View application and build logs |
29 | | -- Kick off application builds |
30 | | -- Disable and Enable projects |
| 12 | +For development builds, see the [releases page](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/releases). Follow the [Install from a VSIX](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) instructions to install. |
31 | 13 |
|
32 | | -## Screenshots |
| 14 | +## How to use [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-tutorial) |
| 15 | +- Navigate to the **Explorer** view group and open the **Microclimate** view. |
| 16 | + - Right-click the background of the Microclimate view to access the **New connection** commands. |
| 17 | + - Right-click a connection or project to access the other commands. |
| 18 | +- Open the **Command Palette** keys and type "Microclimate" to see the actions available. |
33 | 19 |
|
34 | | - |
| 20 | +## Features [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-commands-overview) |
| 21 | +- View all projects in Microclimate, including application and build statuses. |
| 22 | +- Debug Microprofile, Spring, and Node.js Microclimate projects. |
| 23 | +- View application and build logs in the VS Code **Output** view. |
| 24 | +- View project information similar to the information on the Microclimate **Overview** page. |
| 25 | +- Integrate Microclimate validation errors into the VS Code **Problems** view. |
| 26 | +- Open a shell session into a Microclimate application container. |
| 27 | +- Toggle project auto build and manually initiate project builds. |
| 28 | +- Scope your VS Code workspace to a Microclimate project or to your `microclimate-workspace`. |
| 29 | +- Disable, enable, and delete projects. |
0 commit comments