From 7b25da00aeec33ea4cc40a01dd38a82fa7b70c65 Mon Sep 17 00:00:00 2001 From: Geoffroy Van Cutsem Date: Mon, 11 Jul 2022 19:11:12 +0200 Subject: [PATCH] doc: add ACRN Sample App doc to toctree 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 --- doc/try.rst | 1 + misc/sample_application/README.rst | 34 +++++++++++++++++++----------- 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/doc/try.rst b/doc/try.rst index 0f145adf1..abbbcdd7e 100644 --- a/doc/try.rst +++ b/doc/try.rst @@ -15,6 +15,7 @@ hypervisor, the Service VM, and a User VM on a supported Intel target platform. reference/hardware getting-started/overview_dev getting-started/getting-started + misc/sample_application/README After getting familiar with ACRN development, check out these :ref:`develop_acrn` for information about more-advanced scenarios and enabling diff --git a/misc/sample_application/README.rst b/misc/sample_application/README.rst index df301b842..8f198729d 100644 --- a/misc/sample_application/README.rst +++ b/misc/sample_application/README.rst @@ -1,12 +1,22 @@ -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. - -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 +.. _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. + +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