aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTimos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>2024-12-03 10:19:51 +0200
committerTimos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>2024-12-03 10:43:32 +0200
commit266db2473316eb02c6c9d12c14ae2b917fda5d2c (patch)
tree0b407286fbc193c3264d2aee26b52f6f3452281b /README.md
parent5d3c11bfab25ba6ffc37182df25c82d23dfcfb36 (diff)
Update virtio-loopback adapter documentation
Updates: - Add documentation guide - Update README and point to the above guide Change-Id: I29975363b470845419b1924eb0ac16a1535f805d Signed-off-by: Timos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 3 insertions, 5 deletions
diff --git a/README.md b/README.md
index bf0b746..a15015b 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,14 @@
# virtio-loopback adapter repository
-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.
+This repository includes the "virtio_loopback_adapter" application which is part of the Virtio-loopback design. If you want to learn more about how to set up and test the whole virtio-loopback architecture, refer to the [virtio-loopback testing guide](https://gerrit.automotivelinux.org/gerrit/gitweb?p=src/virtio/virtio-loopback-adapter.git;a=blob;f=Documentation/testing_virtio_loopback_design.md;hb=HEAD).
-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).
+This work carried on by Virtual Open Systems in the [Automotive Grade Linux](https://www.automotivegradelinux.org) community.
## Build the virtio-loopback adapter
In order to build this project the next commands need to be used:
- `make` for x86
- `make ARCH=arm64` for arm64
+- `make ARCH=riscv64` for riscv64
**NOTE**: You can also use the parameter "DEBUG=1" in order to enable the debug messages.
-
-Example building the adapter with all the available parameters:
-`make ARCH=arm64 DEBUG=1`