Match current template, add info on Features and image metadata (#62)
* Match current template, add info on Features and image metadata * Update * Fix typo * Fix typo * Remove bad comment about user name * Update portsAttributs ref * Remove otherPortsAttributes given the reference * Typo
This commit is contained in:
		
							
								
								
									
										19
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										19
									
								
								README.md
									
									
									
									
									
								
							@@ -2,7 +2,7 @@
 | 
			
		||||
 | 
			
		||||
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode-remote-try-python)
 | 
			
		||||
 | 
			
		||||
A **development container** is a running [Docker](https://www.docker.com) container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers with **[GitHub Codespaces](https://github.com/features/codespaces)** or **[Visual Studio Code Dev Containers](https://aka.ms/vscode-remote/containers)**.
 | 
			
		||||
A **development container** is a running container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers with **[GitHub Codespaces](https://github.com/features/codespaces)** or **[Visual Studio Code Dev Containers](https://aka.ms/vscode-remote/containers)**.
 | 
			
		||||
 | 
			
		||||
This is a sample project that lets you try out either option in a few easy steps. We have a variety of other [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) sample projects, too.
 | 
			
		||||
 | 
			
		||||
@@ -12,8 +12,9 @@ This is a sample project that lets you try out either option in a few easy steps
 | 
			
		||||
 | 
			
		||||
### GitHub Codespaces
 | 
			
		||||
Follow these steps to open this sample in a Codespace:
 | 
			
		||||
1. Click the Code drop-down menu and select the **Open with Codespaces** option.
 | 
			
		||||
1. Select **+ New codespace** at the bottom on the pane.
 | 
			
		||||
1. Click the **Code** drop-down menu.
 | 
			
		||||
2. Click on the **Codespaces** tab.
 | 
			
		||||
3. Click **Create codespace on main** .
 | 
			
		||||
 | 
			
		||||
For more information on creating your codespace, visit the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace).
 | 
			
		||||
 | 
			
		||||
@@ -41,13 +42,14 @@ Follow these steps to open this sample in a container using the VS Code Dev Cont
 | 
			
		||||
 | 
			
		||||
Once you have this sample opened, you'll be able to work with it like you would locally.
 | 
			
		||||
 | 
			
		||||
> **Note:** This container runs as a non-root user with sudo access by default. Comment out `"remoteUser": "vscode"` in `.devcontainer/devcontainer.json` if you'd prefer to run as root.
 | 
			
		||||
 | 
			
		||||
Some things to try:
 | 
			
		||||
 | 
			
		||||
1. **Edit:**
 | 
			
		||||
   - Open `app.py`
 | 
			
		||||
   - Try adding some code and check out the language features.
 | 
			
		||||
   - Make a spelling mistake and notice it is detected. The [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) extension was automatically installed because it is referenced in `.devcontainer/devcontainer.json`.
 | 
			
		||||
   - Also notice that utilities like `pylint` and the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) extension are installed. Tools are installed in the `mcr.microsoft.com/devcontainers/python` image and Dev Container settings and metadata are automatically picked up from [image labels](https://containers.dev/implementors/reference/#labels).
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
2. **Terminal:** 
 | 
			
		||||
    - Press <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>\`</kbd> to open a terminal window.
 | 
			
		||||
@@ -79,6 +81,13 @@ Some things to try:
 | 
			
		||||
   - Modify the `"onAutoForward"` attribute in your `portsAttributes` from `"notify"` to `"openBrowser"`.
 | 
			
		||||
   - Press <kbd>F1</kbd> and select the **Dev Containers: Rebuild Container** or **Codespaces: Rebuild Container** command so the modifications are picked up.  
 | 
			
		||||
 | 
			
		||||
5. **Install Node.js using a Dev Container Feature:**
 | 
			
		||||
   - Press <kbd>F1</kbd> and select the **Dev Containers: Configure Container Features...** or **Codespaces: Configure Container Features...** command.
 | 
			
		||||
   - Type "node" in the text box at the top.
 | 
			
		||||
   - Check the check box next to "Node.js (via nvm) and yarn" (published by devcontainers) 
 | 
			
		||||
   - Click OK
 | 
			
		||||
   - Press <kbd>F1</kbd> and select the **Dev Containers: Rebuild Container** or **Codespaces: Rebuild Container** command so the modifications are picked up.
 | 
			
		||||
 | 
			
		||||
### More samples
 | 
			
		||||
 | 
			
		||||
- [Tweeter App - Python and Django](https://github.com/Microsoft/python-sample-tweeterapp)
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user