readme review

This commit is contained in:
kieferrm
2019-04-26 21:06:26 +00:00
parent 960a9917d6
commit 9a44a78b02

View File

@@ -1,34 +1,34 @@
# Try Out Development Containers: Java # Try Out Development Containers: Java
This is a sample project to go along with the "try" quick start for the **[VS Code Remote - Containers](https://aka.ms/vscode-remote/containers)** extension. This is a sample project to go along with the "Try a dev container" quick start for the **[VS Code Remote - Containers](https://aka.ms/vscode-remote/containers)** extension.
**If you aren't already following the quick start, [see here](#setting-up-the-development-container).** **If you aren't already following the quick start, [see below](#setting-up-the-development-container).**
## Things to try ## Things to try
One you have this sample opened in a container, you'll be able to work with it like you would locally. Once you have this sample opened in a container, you'll be able to work with it like you would locally.
Some things to try: Some things to try:
1. **Edit:** 1. **Edit:**
1. Open `src\main\java\com\mycompany\app\App.java` 1. Open `src/main/java/com/mycompany/app/App.java`.
2. Try adding some code and check out the language features. 2. Try adding some code and check out the language features.
2. **Terminal:** Press <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>\`</kbd> and type `uname` and other Linux commands from the terminal window. 2. **Terminal:** Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>\`</kbd> and type `uname` and other Linux commands from the terminal window.
3. **Build, Run, and Debug:** 3. **Build, Run, and Debug:**
1. Open `src\main\java\com\mycompany\app\App.java` 1. Open `src/main/java/com/mycompany/app/App.java`.
2. Add a breakpoint. 2. Add a breakpoint.
3. Press <kbd>F5</kbd> to launch the app in the container. 3. Press <kbd>F5</kbd> to launch the app in the container.
4. Once the breakpoint is hit, try hovering over variables, examining locals, and more. 4. Once the breakpoint is hit, try hovering over variables, examining locals, and more.
4. **Run a Test:** 4. **Run a Test:**
1. Open `src\main\java\com\mycompany\app\AppTest.java` 1. Open `src/main/java/com/mycompany/app/AppTest.java`.
2. Put a breakpoint in a test. 2. Put a breakpoint in a test.
3. Click the Debug Test in the Code Lens above the function and watch it hit the breakpoint. 3. Click the `Debug Test` in the Code Lens above the function and watch it hit the breakpoint.
## Setting up the development container ## Setting up the development container
Follow these steps to open this sample in a container: Follow these steps to open this sample in a container:
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to get set up. 1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started).
2. If you're not yet in a development container: 2. If you're not yet in a development container:
1. Clone this repository. 1. Clone this repository.
@@ -51,5 +51,5 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
## License ## License
Copyright © Microsoft Corporation All rights reserved.<br /> Copyright <EFBFBD> Microsoft Corporation All rights reserved.<br />
Licensed under the MIT License. See LICENSE in the project root for license information. Licensed under the MIT License. See LICENSE in the project root for license information.