diff --git a/docs/gh-continue-in-codespaces.png b/docs/gh-continue-in-codespaces.png new file mode 100644 index 000000000..d9594b61f Binary files /dev/null and b/docs/gh-continue-in-codespaces.png differ diff --git a/docs/gh-focus-on-terminal.png b/docs/gh-focus-on-terminal.png new file mode 100644 index 000000000..af4fd0a3a Binary files /dev/null and b/docs/gh-focus-on-terminal.png differ diff --git a/docs/github-codespaces.md b/docs/github-codespaces.md index 690d0a319..b72d42e4e 100644 --- a/docs/github-codespaces.md +++ b/docs/github-codespaces.md @@ -2,7 +2,20 @@ A GitHub codespace container with all dependencies and several useful tools preinstalled is configured in the `.devcontainer` directory. -You can go to https://github.dev/diasurgical/devilutionX/ and immediately begin developing. +To develop in a codespace, open the in-browser VS Code editor by either pressing the `.` or going to https://github.dev/diasurgical/devilutionX/. + +Then, focus on the terminal window from the Command Palette menu (F1): + +![screenshot](gh-focus-on-terminal.png) + +Then, click "Continue Working in GitHub Codespaces": + +![screenshot](gh-continue-in-codespaces.png) + +It will take a few minutes to build the container. + +Once installed, the page will load back into the in-browser VS Code editor but now with a +container shell. To view the graphical desktop of the container, click Ports > Browser.