Codespaces

Github Codespaces lets you spawn a Dreamcast development environment in your browser in a matter of minutes.

The only things you need are:

• a browser
• a github login.

Steps Overview

The main steps to get a Codespace working, are:

• Login into github
• Create your code repository, or fork one
• Add a .devcontainer/devcontainer.json file to that repository
• Create & launch your codespace, and enjoy the IDE in your browser !

That's all there is to it.

Example 1: KallistiOS examples

To compile the KallistiOS examples in a Codespace:

• Login into github
• Got to the KallistiOS repository
• Click on the "Fork" button, this will create a KallistiOS repository inside your account
• Click on the "Add File" button, then "Create New File"
• Name the file: ".devcontainer/devcontainer.json", and paste the following contents:

// For format details, see https://aka.ms/devcontainer.json. 
// For config options, see the README at: https://github.com/devcontainers/templates/tree/main/src/alpine
{
	"name": "My_Codespace",
		
	// Either use a pre-built image (= a Docker container)...
	"image": "ghcr.io/kos-builds/kos-ports-dc:sha-656a397-14.1.0",
	// ... or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
	//"build": { // Path is relative to the devcontainer.json file.
	//    "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": [],

	// Use 'postCreateCommand' to run commands after the container is created.
	//"postCreateCommand": "source /opt/toolchains/dc/kos/environ.sh",

	// Configure tool-specific properties.
	"customizations": {
	    "vscode": {
	        "extensions": [
		    "ms-vscode.cpptools"
	        ]
	    }
	}

	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
	// "remoteUser": "root"
}

• Commit (aka, save) the file
• Launch your Codespace by clicking on the "<> Code" button, then "Codespaces" - "Create codespace on main".
• This will launch Visual Studio Code in your browser. The first time it will take a couple of minutes to launch, after that it will be faster.
• TODO: navigate to examples, compile one, download elf

Tips

• TODO