mirror of
https://github.com/aljazceru/kata-containers.git
synced 2025-12-26 10:34:24 +01:00
82d105f759
Resolve a number of syntax issues that were lurking in the markdown. Fixes: #1564. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
57 lines
1.1 KiB
Markdown
57 lines
1.1 KiB
Markdown
|
|
Table of Contents
|
|
=================
|
|
|
|
* [Prerequisites](#prerequisites)
|
|
* [Building](#building)
|
|
* [Testing](#testing)
|
|
* [Submitting changes](#submitting-changes)
|
|
|
|
# Prerequisites
|
|
|
|
`virtcontainers` has a few prerequisites for development:
|
|
|
|
- docker
|
|
- CNI
|
|
- golang
|
|
- gometalinter
|
|
|
|
A number of these can be installed using the
|
|
[virtcontainers-setup.sh](../utils/virtcontainers-setup.sh) script.
|
|
|
|
# Building
|
|
|
|
To build `virtcontainers`, at the top level directory run:
|
|
|
|
```bash
|
|
# make
|
|
```
|
|
|
|
# Testing
|
|
|
|
Before testing `virtcontainers`, ensure you have met the [prerequisites](#prerequisites).
|
|
|
|
Before testing you need to install virtcontainers. The following command will install
|
|
`virtcontainers` into its own area (`/usr/bin/virtcontainers/bin/` by default).
|
|
|
|
```
|
|
# sudo -E PATH=$PATH make install
|
|
```
|
|
|
|
To test `virtcontainers`, at the top level run:
|
|
|
|
```
|
|
# make check
|
|
```
|
|
|
|
This will:
|
|
|
|
- run static code checks on the code base.
|
|
- run `go test` unit tests from the code base.
|
|
|
|
# Submitting changes
|
|
|
|
For details on the format and how to submit changes, refer to the
|
|
[Contributing](../../CONTRIBUTING.md) document.
|
|
|