Skip to content
This repository was archived by the owner on Nov 30, 2023. It is now read-only.

Commit d4d28c3

Browse files
committed
Updated Ruby README, test project
1 parent 8075916 commit d4d28c3

File tree

3 files changed

+34
-11
lines changed

3 files changed

+34
-11
lines changed

containers/ruby-2/.vscode/launch.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"version": "0.2.0",
66
"configurations": [
77
{
8-
"name": "Debug Local File",
8+
"name": "Debug Hello",
99
"type": "Ruby",
1010
"request": "launch",
1111
"cwd": "${workspaceRoot}",

containers/ruby-2/README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,40 @@
1010
| *Definition type* | Dockerfile |
1111
| *Languages, platforms* | Ruby |
1212

13-
## Usage
13+
## Using this definition with an existing folder
1414

15-
[See here for information on using this definition with an existing project](../../README.md#using-a-definition).
15+
This definition does require any special steps to use. Just follow these steps:
1616

17-
If you prefer, you can also just look through the contents of the `.devcontainer` folder to understand how to make changes to your own project.
17+
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 set up your machine.
1818

19-
If you want to try out the test project instead, run **Remote-Container: Open Folder in Container...** in VS Code and select a cloned copy of the entire folder. You can then start the test program from Debug panel in VS Code.
19+
2. To use VS Code's copy of this definition:
20+
1. Start VS Code and open your project folder.
21+
2. Press <kbd>F1</kbd> select and **Remote-Containers: Create Container Configuration File...** from the command palette.
22+
3. Select the Ruby 2 definition.
23+
24+
3. To use latest-and-greatest copy of this definition from the repository:
25+
1. Clone this repository.
26+
2. Copy the contents of `containers/ruby-2/.devcontainer` to the root of your project folder.
27+
3. Start VS Code and open your project folder.
28+
29+
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
30+
31+
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** to start using the definition.
32+
33+
## Testing the definition
34+
35+
This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:
36+
37+
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 set up your machine.
38+
2. Clone this repository.
39+
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
40+
4. Select the `containers/ruby-2` folder.
41+
5. After the folder has opened in the container, press <kbd>F5</kbd> to start the project.
42+
6. You should see "Hello, Remote Extension Host!" followed by "Hello, Local Extension Host!" in the Debug Console after the program executes.
43+
7. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.
2044

2145
## License
2246

2347
Copyright (c) Microsoft Corporation. All rights reserved.
2448

25-
Licensed under the MIT License. See [LICENSE](../../LICENSE).
49+
Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).

containers/ruby-2/test-project/hello.rb

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
# Licensed under the MIT License. See LICENSE in the project root for license information.
44
#-----------------------------------------------------------------------------------------
55

6-
def sayGoodnight(name)
7-
result = "Goodnight, " + name
6+
def sayHello(name)
7+
result = "Hello, " + name + "!"
88
return result
99
end
1010

1111

12-
# Time for bed...
13-
puts sayGoodnight("John-Boy")
14-
puts sayGoodnight("Mary-Ellen")
12+
puts sayHello("Remote Extension Host")
13+
puts sayHello("Local Extension Host")

0 commit comments

Comments
 (0)