Update README

This commit is contained in:
zakarya 2019-11-13 12:54:31 +01:00
parent b220ee0bd1
commit e99eaa8a25
1 changed files with 6 additions and 11 deletions

View File

@ -1,12 +1,14 @@
# 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.
Shared memory is a kernel-managed memory area that can be read and written by the Library.
## Features
- set shared memory keys
- Manage the shared memory
- Create new key for the shared memory.
- Ask the user if he want to change the key of shared memory.
- Create shared memory and make it available to use it
- Delete the shared memory.
## Installation
@ -15,17 +17,10 @@ to install the full package.
Installing a single component is currently not supported.
## Usage
## 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.