aljaz/kata-containers
1
0
Fork 0
mirror of https://github.com/aljazceru/kata-containers.git synced 2026-01-15 04:14:24 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
0a2e2c6038ff9623610d62cad8db1d723dd500cb
kata-containers/src/runtime/virtcontainers/documentation/Developers.md
James O. D. Hunt 4f0726bc49 docs: Remove table of contents 
Removed all TOCs now that GitHub auto-generates them.

Also updated the documentation requirements doc removing the requirement
to add a TOC.

Fixes: #2022.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2021-07-30 10:58:22 +01:00

936 B
Raw Blame History

Prerequisites

virtcontainers has a few prerequisites for development:

  • docker
  • CNI
  • golang

A number of these can be installed using the virtcontainers-setup.sh script.

Building

To build virtcontainers, at the top level directory run:

# make

Testing

Before testing virtcontainers, ensure you have met the 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 document.