github.com/kata-containers/runtime@v0.0.0-20210505125100-04f29832a923/virtcontainers/documentation/Developers.md (about)

     1  
     2  Table of Contents
     3  =================
     4  
     5     * [Prerequisites](#prerequisites)
     6     * [Building](#building)
     7     * [Testing](#testing)
     8     * [Submitting changes](#submitting-changes)
     9  
    10  # Prerequisites
    11  
    12  `virtcontainers` has a few prerequisites for development:
    13  
    14  - docker
    15  - CNI
    16  - golang
    17  
    18  A number of these can be installed using the
    19  [virtcontainers-setup.sh](../utils/virtcontainers-setup.sh) script.
    20  
    21  # Building
    22  
    23  To build `virtcontainers`, at the top level directory run:
    24  
    25  ```bash
    26  # make
    27  ```
    28  
    29  # Testing
    30  
    31  Before testing `virtcontainers`, ensure you have met the [prerequisites](#prerequisites).
    32  
    33  Before testing you need to install virtcontainers. The following command will install
    34  `virtcontainers` into its own area (`/usr/bin/virtcontainers/bin/` by default).
    35  
    36  ```
    37  # sudo -E PATH=$PATH make install
    38  ```
    39  
    40  To test `virtcontainers`, at the top level run:
    41  
    42  ```
    43  # make check
    44  ```
    45  
    46  This will:
    47  
    48  - run static code checks on the code base.
    49  - run `go test` unit tests from the code base.
    50  
    51  # Submitting changes
    52  
    53  For details on the format and how to submit changes, refer to the
    54  [Contributing](../../CONTRIBUTING.md) document.
    55