library/README.md

32 lines
845 B
Markdown
Raw Normal View History

# vKVM Library
2019-10-23 16:11:16 +02:00
#Background
2019-10-23 16:11:16 +02:00
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, ect.
## Installation
Use the installation script provided in the Scripts repository
to install the full package.
Installing a single component is currently not supported.
## Usage
Include this library with
```
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.