2019-10-16 15:11:16 +02:00
|
|
|
# vKVM Library
|
|
|
|
|
2019-10-23 17:38:27 +02:00
|
|
|
# Background
|
2019-10-23 17:12:04 +02:00
|
|
|
|
2019-10-23 17:38:27 +02:00
|
|
|
This Library was created to make it easier for developers to understand the overall project framework,
|
2019-10-23 16:11:16 +02:00
|
|
|
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.
|
2019-10-23 17:38:27 +02:00
|
|
|
It can provided font changes, event handling, pixel color, button control, keyboard response ect.
|
2019-10-23 17:12:04 +02:00
|
|
|
|
|
|
|
## Installation
|
2019-10-16 15:11:16 +02:00
|
|
|
|
|
|
|
Use the installation script provided in the Scripts repository
|
|
|
|
to install the full package.
|
|
|
|
|
|
|
|
Installing a single component is currently not supported.
|
|
|
|
|
2019-10-23 17:12:04 +02:00
|
|
|
## Usage
|
2019-10-16 15:11:16 +02:00
|
|
|
|
|
|
|
Include this library with
|
|
|
|
|
2019-10-23 17:38:27 +02:00
|
|
|
```sh
|
2019-10-16 15:11:16 +02:00
|
|
|
set(LIB_PATH "${CMAKE_SOURCE_DIR}/../library")
|
|
|
|
|
|
|
|
include_directories(${LIB_PATH}/include)
|
|
|
|
add_executable(your_client ${SOURCES} ${HEADERS})
|
|
|
|
|
|
|
|
target_link_libraries(your_client ${LIB_PATH}/lib/liblibrary.a)
|
|
|
|
```
|
|
|
|
in your CMakeLists.
|
|
|
|
|
|
|
|
More documentation coming soon.
|