Browse Source

better README

master
Johannes Theiner 2 years ago
parent
commit
4fb770bf69
  1. 36
      README.md

36
README.md

@ -1,11 +1,13 @@
# vKVM Library
# Background
This library allows for easy interaction with the graphical user interface of the vKVM project.
This Library was created to make it easier for developers to understand the overall project framework,
and to make the code of each department uniform and standardized.
It can provide names for many variables and methods that people can easily call and implement.
It can provided font changes, event handling, pixel color, button control, keyboard response ect.
## Features
- set pixel color
- respond to keyboard/mouse events
- get/set text to be drawn
## Installation
@ -14,18 +16,32 @@ to install the full package.
Installing a single component is currently not supported.
## Usage
## Include
Include this library with
```sh
set(LIB_PATH "${CMAKE_SOURCE_DIR}/../library")
```
set(LIB_PATH "${CMAKE_SOURCE_DIR}/../relative_path_to_library_folder")
include_directories(${LIB_PATH}/include)
add_executable(your_client ${SOURCES} ${HEADERS})
target_link_libraries(your_client ${LIB_PATH}/lib/liblibrary.a)
```
in your CMakeLists.
in your CMakeList.
## Usage
```cpp
#include <vkvm.h>
int main(int argc, char* argv[]) {
if(argc != 1) return -1;
int pid = std::stoi(argv[0]);
initialize(pid);
setPixel(10, 10, Color::black);
setPixel(10, 20, Color::red);
}
More documentation coming soon.
```
Loading…
Cancel
Save