update readme

This commit is contained in:
Lily Tsuru 2024-12-02 03:35:15 -05:00
parent f04338fd2b
commit af21cd3686

View file

@ -2,13 +2,14 @@
A semi-prototype of CollabVM 3.0 agent functionality (specifically display). A semi-prototype of CollabVM 3.0 agent functionality (specifically display).
Currently NVIDIA-specific; support for DXGI duplication (for post Win7) should be added at some point Currently NVIDIA-specific (since we use NvFBC); support for DXGI duplication (for post Win7) should be added at some point.
The agent should run on Windows 7 x64 onwards. Lower (or x86) is currently not supported as a target. The agent runs on Windows 7 x64 onwards. Lower (or x86) is currently not supported as a target.
TCP sockets are currently used; this will be replaced with virtio-serial (mediated on top of agent pluggable support) and IVSHMEM. The agent uses IVSHMEM to provide frames to the client in a low-latency fashion. Later on virtio-serial may be considered for low-bandwidth additional functionality, like input. For now, however, the agent is display only.
This repository contains: This repository contains:
- The agent. - The agent. Written in C++20.
- A simple server end, written in Rust, which displays the framebuffer (in rather unoptimal fashion, both networking and graphics-wise.). Written for testing only. - Shared headers and utility code, used between the agent and the client. Written in C++20, mostly so it can be shared between the agent and client.
- A simple client, written mostly in Rust (with some C++ glue), which displays the framebuffer (in a quick-and-dirty fashion.). Mostly test-only code. Some of it isn't though!