github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-08-18 08:11:07 +00:00
Code Issues Projects Releases Wiki Activity

sample app: conform README to repo RST standard

Browse Source 
This commit changes the README from Markdown to RST.

Tracked-On #7820
Signed-off-by: Matthew Leon <matthew.leon@intel.com>
This commit is contained in:
Matthew Leon 2022-06-28 11:12:10 -07:00 committed by acrnsi-robot
parent d8f55c7bca
commit 905b31549e
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
misc/sample_application/README.md
View File

@ -1,7 +0,0 @@
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 uservm 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.

12
misc/sample_application/README.rst Normal file
View File

@ -0,0 +1,12 @@
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