Skip to content

Commit

Permalink
chore(dev): small readme fixes to devcontainer
Browse files Browse the repository at this point in the history
  • Loading branch information
qdm12 committed Oct 20, 2024
1 parent 03f5d0b commit a690c38
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .devcontainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,18 @@ It works on Linux, Windows (WSL2) and OSX.
- [VS code](https://code.visualstudio.com/download) installed
- [VS code dev containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed
- [Docker](https://www.docker.com/products/docker-desktop) installed and running
- [Docker Compose](https://docs.docker.com/compose/install/) installed

## Setup

1. Create the following files and directory on your host if you don't have them:

```sh
touch ~/.gitconfig ~/.zsh_history
mkdir -p ~/.ssh
```

1. **For OSX hosts**: ensure your home directory `~` is accessible by Docker.
1. **For OSX hosts**: ensure the project directory and your home directory `~` is accessible by Docker.
1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P).
1. Select `Dev-Containers: Open Folder in Container...` and choose the project directory.

Expand Down

0 comments on commit a690c38

Please sign in to comment.