Skip to content

Commit

Permalink
Support Development Containers, add GitHub Codespaces badge
Browse files Browse the repository at this point in the history
  • Loading branch information
er2 committed Nov 24, 2024
1 parent d345dbe commit ea864fc
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 0 deletions.
1 change: 1 addition & 0 deletions .devcontainer/Dockerfile
26 changes: 26 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
{
"name": "GameShell Dev Container",
"build": {
// Sets the run context to one level up instead of the .devcontainer folder.
"context": "..",
// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
"dockerfile": "Dockerfile"
}

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Uncomment the next line to run commands after the container is created.
// "postCreateCommand": "cat /etc/os-release",

// Configure tool-specific properties.
// "customizations": {},

// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "devcontainer"
}
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ We are particularly interested in any new missions you might create!
Getting started
---------------

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?repo=683544958)

GameShell should work on any standard Linux system, and also on macOS and BSD
(but we have run fewer tests on the latter systems). On Debian or Ubuntu, the
only dependencies (besides `bash`) are the `gettext-base` and `awk` packages
Expand Down Expand Up @@ -72,6 +74,20 @@ you want to run X programs from inside GameShell. Refer to [this
section](./doc/deps.md#running-GameShell-from-a-docker-container) of the user
manual.

Github Codespaces
-----------------

This repository features a [devcontainer.json](https://containers.dev/) enabling
GameShell to be run directly from a [Github Codespace](https://github.com/features/codespaces).

Once the Codespace is launched, you can run GameShell in the terminal with:

```sh
bash start.sh
```

To get the same experience on your local machine without the limitations/cost
of Codespaces see [the Dev Container docs](https://containers.dev/supporting#tools)

Documentation
-------------
Expand Down

0 comments on commit ea864fc

Please sign in to comment.