[Spice-devel] [spice-gtk v1 2/5] README: Use Markdown format

Victor Toso victortoso at redhat.com
Tue May 14 16:25:59 UTC 2019


From: Victor Toso <me at victortoso.com>

No other significant changes in the content were done besides format.

Signed-off-by: Victor Toso <victortoso at redhat.com>
---
 README.md | 72 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 42 insertions(+), 30 deletions(-)

diff --git a/README.md b/README.md
index 612027d..101da4d 100644
--- a/README.md
+++ b/README.md
@@ -8,52 +8,64 @@ Please report bugs at: spice-devel at lists.freedesktop.org
 Project content
 ---------------
 
-libspice-client-glib-2.0
-   provides glib objects for spice protocol decoding and surface rendering.
-      * SpiceSession (see spice-session.h).
-      * SpiceChannel (see spice-channel.h).
-      * SpiceAudio (see spice-audio.h).
-      * Various Spice<Type>Channel (see channel-<type>.h).
-
-libspice-client-gtk-3.0
-   provides gtk widget to show spice display and accept user input.
-      * SpiceDisplay (see spice-widget.h)
-
-spicy
+* **libspice-client-glib-2.0**
+
+    Provides glib objects for spice protocol decoding and surface rendering.
+    * SpiceSession (see spice-session.h).
+    * SpiceChannel (see spice-channel.h).
+    * SpiceAudio (see spice-audio.h).
+    * Various Spice<Type>Channel (see channel-<type>.h).
+
+* **libspice-client-gtk-3.0**
+
+    provides gtk widget to show spice display and accept user input.
+    * SpiceDisplay (see spice-widget.h)
+
+* **spicy**
+
    a gtk test client. The recommended client for end user is
-   virt-viewer (https://pagure.io/virt-viewer)
+   [virt-viewer]
+
+* **spicy-screenshot**
 
-spicy-screenshot
    Command line tool, connects to spice server and writes out a
    screen shot.
 
-spicy-stats
+* **spicy-stats**
+
    Command line tool, connects to spice server and writes out a
    summary of connection details, amount of bytes transferred...
 
-SpiceClientGlib and SpiceClientGtk GObject-introspection modules.
+* **SpiceClientGlib** and **SpiceClientGtk** GObject-introspection modules.
+
+[virt-viewer]: https://pagure.io/virt-viewer
 
 Build dependencies:
 ------------------
 
-. On Fedora use:
+* On Fedora use:
 
-dnf builddep spice-gtk
+>>>
+    dnf builddep spice-gtk
+>>>
 
-. or install:
+* or install:
 
-gtk3-devel spice-protocol
-openssl-devel pulseaudio-libs-devel pixman-devel
-gobject-introspection-devel libjpeg-turbo-devel zlib-devel
-cyrus-sasl-devel gtk-doc
+>>>
+    gtk3-devel spice-protocol openssl-devel pulseaudio-libs-devel pixman-devel
+    gobject-introspection-devel libjpeg-turbo-devel zlib-devel cyrus-sasl-devel gtk-doc
+>>>
 
-. The GStreamer backend needs:
+The GStreamer backend needs:
 
-gstreamer1-devel gstreamer1-plugins-base-devel gstreamer1-plugins-good gstreamer1-plugins-bad-free
+>>>
+    gstreamer1-devel gstreamer1-plugins-base-devel gstreamer1-plugins-good gstreamer1-plugins-bad-free
+>>>
 
-. If you build from git, you'll also need:
+* If you build from git, you'll also need:
 
-libtool automake gettext-devel vala vala-tools
-  python2 python2-pyparsing
-or
-  python3 python3-pyparsing
+>>>
+    libtool automake gettext-devel vala vala-tools
+    python3 python3-pyparsing
+    # or python2 python2-pyparsing
+>>>
-- 
2.20.1



More information about the Spice-devel mailing list