diff options
| author |   Timos Ampelikiotis <t.ampelikiotis@virtualopensystems.com> | 2022-11-30 15:05:09 +0100 |
|---|---|---|
| committer |   Angelos Mouzakitis <a.mouzakitis@virtualopensystems.com> | 2023-10-03 15:18:54 +0300 |
| commit | 8b82f2a4574e70ad1667c53a6fa6e896d9cb8d77 (patch) | |
| tree | 6303344a605d68fcf5d969840c40847859d5e94c /README.md | |
| parent | fc33f9b651babf991fc39306764e3d6d7b68143b (diff) | |
Update Readme file on virtio-loopback Beta version
Signed-off-by: Timos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 5 insertions, 8 deletions
@@ -1,8 +1,8 @@ # virtio-loopback adapter repository -This repository includes a alpha version of the "virtio_loopback_adapter" application which is part of the Virtio Loopback Design presented in this [document](https://git.virtualopensystems.com/virtio-loopback/docs/-/blob/master/design_docs). +This repository includes the beta version of the "virtio_loopback_adapter" application which is part of the Virtio Loopback Design presented in this [document](https://git.virtualopensystems.com/virtio-loopback/docs/-/blob/master/design_docs). This work carried on by Virtual Open Systems in the [Automotive Grade Linux](https://www.automotivegradelinux.org) community. -As described in the design document, the adapter is only a part of a more complex architecture. If you want to see the implementation and build the other componets, refer to the [virtio-loopback docs repository](https://git.virtualopensystems.com/c-022/virtio-loopback/docs). +As described in the design document, the adapter is only a part of a more complex architecture. If you want to see the implementation and build the other components, refer to the [virtio-loopback docs repository](https://git.virtualopensystems.com/virtio-loopback/docs/-/tree/beta-release). ## Build the virtio-loopback adapter @@ -10,10 +10,7 @@ In order to build this project the next commands need to be used: - `make` for x86 - `make ARCH=arm64` for arm64 -**NOTE**: You can also use the parameter "DEBUG=1" in order to enable the debug messages and "VHOST_USER_RNG=1" which tells to the adapter to use an external entropy source. An external entropy source in our case is a rng-user-space drivers which communicates with the adapter via the "vhost-user" protocol. If the option "VHOST_USER_RNG" is not specified into the "make" command, then the adapter will use its internal mechanism and produce its own random numbers (this case is used only for testing purposes). +**NOTE**: You can also use the parameter "DEBUG=1" in order to enable the debug messages. -Exaple building the adapter with all the available parameters: -`make ARCH=arm64 VHOST_USER_RNG=1 DEBUG=1` - -## Current status -This repository contains the current results of the activity carried on by Virtual Open Systems in the [Automotive Grade Linux](https://www.automotivegradelinux.org) community. Both code and documentation included in this release are under active development, and are intended to be used to familiarize with the concept of virtio-loopback and to give developers the opportunity to test it. +Example building the adapter with all the available parameters: +`make ARCH=arm64 DEBUG=1` |