Go to file
Johannes Theiner 4fb770bf69 better README 2019-10-28 18:41:41 +00:00
src + internal header documentation. 2019-10-24 09:38:58 +02:00
test + Catch2 as Unit Test Framework 2019-10-16 15:11:16 +02:00
.gitignore + Catch2 as Unit Test Framework 2019-10-16 15:11:16 +02:00
CHANGELOG.md + public header fully documented. 2019-10-23 17:12:04 +02:00
CMakeLists.txt + clang_tidy 2019-10-21 15:19:26 +00:00
LICENSE + Catch2 as Unit Test Framework 2019-10-16 15:11:16 +02:00
README.md better README 2019-10-28 18:41:41 +00:00

README.md

vKVM Library

This library allows for easy interaction with the graphical user interface of the vKVM project.

Features

  • set pixel color
  • respond to keyboard/mouse events
  • get/set text to be drawn

Installation

Use the installation script provided in the Scripts repository to install the full package.

Installing a single component is currently not supported.

Include

Include this library with

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 CMakeList.

Usage

#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);
}