github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-19 12:12:16 +00:00
Code Issues Projects Releases Wiki Activity

doc: add ACRN Sample App doc to toctree

Browse Source 
Add the ACRN Sample App document (README.rst) to the toctree
Convert the README.rst from Dos to Unix text file format

Tracked-On: #7820
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
This commit is contained in:
Geoffroy Van Cutsem 2022-07-11 19:11:12 +02:00 committed by acrnsi-robot
parent 0e0bf3321f
commit 7b25da00ae
2 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/try.rst
View File

@ -15,6 +15,7 @@ hypervisor, the Service VM, and a User VM on a supported Intel target platform.
reference/hardware reference/hardware
getting-started/overview_dev getting-started/overview_dev
getting-started/getting-started getting-started/getting-started
misc/sample_application/README
After getting familiar with ACRN development, check out these After getting familiar with ACRN development, check out these
:ref:`develop_acrn` for information about more-advanced scenarios and enabling :ref:`develop_acrn` for information about more-advanced scenarios and enabling

34
misc/sample_application/README.rst
View File

@ -1,12 +1,22 @@
ACRN Sample Application .. _sample-app:
#######################
ACRN Sample Application
This directory contains a software application that runs a real-time application between a real-time VM and a standard VM using the acrn-hypervisor. #######################
The ``rtvm`` directory contains the code that reads and pipes data from ``cyclictest`` to the User VM using the inter-vm shared memory feature that acrn-hypervisor exposes to its VMs. This directory contains a software application that runs a real-time
application between a real-time VM and a standard VM using the
The ``uservm`` directory contains the code that reads the piped data from the RTVM, processes the data, and displays the data over a web application that can be accessed from the hypervisor's Service VM. acrn-hypervisor.
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. The ``rtvm`` directory contains the code that reads and pipes data from
``cyclictest`` to the User VM using the inter-vm shared memory feature that
For more information, please go to: https://github.com/projectacrn/acrn-hypervisor/wiki/ACRN-Sample-App acrn-hypervisor exposes to its VMs.
The ``uservm`` directory contains the code that reads the piped data from the
RTVM, processes the data, and displays the 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