acrn-hypervisor/misc/sample_application
Matthew Leon 905b31549e sample app: conform README to repo RST standard
This commit changes the README from Markdown to RST.

Tracked-On #7820
Signed-off-by: Matthew Leon <matthew.leon@intel.com>
2022-07-20 09:36:03 +08:00
..
rtvm
uservm
README.rst sample app: conform README to repo RST standard 2022-07-20 09:36:03 +08:00

README.rst

ACRN Sample Application
#######################

This directory contains the software that is necessary to run a real-time application between a real-time VM and a standard VM using the acrn-hypervisor.

The ``rtvm`` directory contains the code required to pipe data from ``cyclictest`` to the User VM using the inter-vm shared memory feature that acrn-hypervisor exposes to its VMs.

The ``uservm`` directory contains the code required to read the piped data from the RTVM, process the data, and display that data over a web application that can be accessed from the hypervisor's Service VM.

To build and run the applications, copy this repo to your VMs, run make in the directory that corresponds to the VM that you are running, and then follow the sample app guide in the acrn-hypervisor documentation.

For more information, please go to: https://github.com/projectacrn/acrn-hypervisor/wiki/ACRN-Sample-App