Skip to content

Commit 3844f9e

Browse files
committed
Support Development Containers, add GitHub Codespaces badge
1 parent d345dbe commit 3844f9e

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

.devcontainer/Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../Dockerfile

.devcontainer/devcontainer.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
3+
{
4+
"name": "GameShell Dev Container",
5+
"build": {
6+
// Sets the run context to one level up instead of the .devcontainer folder.
7+
"context": "..",
8+
// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
9+
"dockerfile": "Dockerfile"
10+
}
11+
12+
// Features to add to the dev container. More info: https://containers.dev/features.
13+
// "features": {},
14+
15+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
16+
// "forwardPorts": [],
17+
18+
// Uncomment the next line to run commands after the container is created.
19+
// "postCreateCommand": "cat /etc/os-release",
20+
21+
// Configure tool-specific properties.
22+
// "customizations": {},
23+
24+
// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
25+
// "remoteUser": "devcontainer"
26+
}

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ We are particularly interested in any new missions you might create!
3030
Getting started
3131
---------------
3232

33+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new)
34+
3335
GameShell should work on any standard Linux system, and also on macOS and BSD
3436
(but we have run fewer tests on the latter systems). On Debian or Ubuntu, the
3537
only dependencies (besides `bash`) are the `gettext-base` and `awk` packages
@@ -72,6 +74,20 @@ you want to run X programs from inside GameShell. Refer to [this
7274
section](./doc/deps.md#running-GameShell-from-a-docker-container) of the user
7375
manual.
7476

77+
Github Codespaces
78+
-----------------
79+
80+
This repository features a [devcontainer.json](https://containers.dev/) enabling
81+
GameShell to be run directly from a [Github Codespace](https://github.com/features/codespaces).
82+
83+
Once the Codespace is launched, you can run GameShell in the terminal with:
84+
85+
```sh
86+
bash start.sh
87+
```
88+
89+
To get the same experience on your local machine without the limitations/cost
90+
of Codespaces see [the Dev Container docs](https://containers.dev/supporting#tools)
7591

7692
Documentation
7793
-------------

0 commit comments

Comments
 (0)