diff --git a/README.md b/README.md index ad5a2dd..d4f2712 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # vKVM Shared Memory +Shared memory is a kernel-managed memory area that can be read and written by the graphical user interface , Text Renderer and the Library. + +## Features + +- set shared memory keys +- Manage the shared memory + + ## Installation Use the installation script provided in the Scripts repository @@ -7,3 +15,17 @@ to install the full package. Installing a single component is currently not supported. +## Usage + +mkdir build +cd build +cmake .. +make + +## Description + +changedKey(): create new Key for the Shared Memory. +getAnswerFromUser(): ask the User if he want to chgange the Key of Shared Memory. +initSharedMemory(): create Shared Memory and make it available t o use it +deleteSharedMemory(int s): delete the Shared memory. +deleteSharedMemory(): delete the Shared memory.