summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristophe Fergeau <cfergeau@redhat.com>2017-11-08 14:17:00 +0100
committerFrediano Ziglio <fziglio@redhat.com>2017-11-08 13:57:07 +0000
commitc065bbc1ebd94afd098ced6a7e5b20babfe4c3ba (patch)
treec761d12a73fd77e20f1c86ee3f4b386b350fe0d0
parent520b4bf91b9e4dcc7cf7a9a0bd1ed3785d6757b0 (diff)
build: Adjust README
Acked-by: Frediano Ziglio <fziglio@redhat.com>
-rw-r--r--README19
1 files changed, 5 insertions, 14 deletions
diff --git a/README b/README
index d07c014..7e9a3c7 100644
--- a/README
+++ b/README
@@ -2,9 +2,11 @@ Introduction
============
The SPICE Streaming Agent is a guest-side daemon which captures the
-guest X.Org output, encodes it to H.264 using hardware encoding (NVIDIA-only at
-the moment), and forwards the resulting stream to the host to be sent through
-SPICE.
+guest video output, encodes it to a video stream,and forwards the resulting
+stream to the host to be sent through SPICE. The capture and encoding are done
+through the use of plugins, so a variety of video format and capture/encoding
+methods (hardware/software) can be used. For now, spice-streaming-agent only
+provides software encoding to MJPEG.
Virtual Machine Configuration
@@ -39,14 +41,3 @@ Using QEMU
[source,sh]
-device virtserialport,bus=virtio-serial0.0,nr=1,chardev=charchannel1,id=channel1,name=com.redhat.stream.0 -chardev spiceport,name=com.redhat.stream.0,id=charchannel1
-
-
-NVIDIA-specific Configuration
-=============================
-
-In order to use NVIDIA hardware-accelerated encoding, you will need to
-configure the virtual machine to use mdev/vfio. An NVIDIA card has to be listed
-in lspci output on the guest.
-
-The guest also needs to have the NVIDIA proprietary drivers installed and in
-use.