github/containerd
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Adds a dev container and Codespaces docs

Browse Source 
Signed-off-by: Samruddhi Khandale <samruddhikhandale@github.com>
This commit is contained in:
Samruddhi Khandale
2023-03-21 21:05:28 +00:00
parent 3a1047319f
commit 50b576a94e
5 changed files with 111 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
BUILDING.md
View File

@@ -4,12 +4,23 @@ This guide is useful if you intend to contribute on containerd. Thanks for your
effort. Every contribution is very appreciated.
This doc includes:
* [Getting started with GitHub Codespaces](#getting-started-with-gitHub-codespaces)
* [Build requirements](#build-requirements)
* [Build the development environment](#build-the-development-environment)
* [Build containerd](#build-containerd)
* [Via docker container](#via-docker-container)
* [Testing](#testing-containerd)
## Getting started with GitHub Codespaces
To get started, create a codespace for this repository by clicking this 👇
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=46089560)
A codespace will open in a web-based version of Visual Studio Code. The [dev container](.devcontainer/devcontainer.json) is fully configured with software needed for this project and the containerd built. If you use a codespace, then you can directly skip to the [testing](#testing-containerd) section of this document.
**Note**: Dev containers is an open spec which is supported by [GitHub Codespaces](https://github.com/codespaces) and [other tools](https://containers.dev/supporting).
## Build requirements
To build the `containerd` daemon, and the `ctr` simple test client, the following build system dependencies are required: