From 4cf66c00c08bfdd8d191266f97fc885d4aa5b46f Mon Sep 17 00:00:00 2001
From: Arun Raghavan <arun@arunraghavan.net>
Date: Sat, 2 Nov 2019 11:33:52 +0100
Subject: [PATCH] readme: Format in Markdown and add some more information

---
 README    | 35 -----------------------------------
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+), 35 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index fe5645a4d..000000000
--- a/README
+++ /dev/null
@@ -1,35 +0,0 @@
-PipeWire
---------
-
-PipeWire is a server and user space API to deal with multimedia
-pipelines. This includes:
-
-  - Making available sources of video (such as from a capture devices or
-       application provided streams) and multiplexing this with
-       clients.
-  - Accessing sources of video for consumption.
-  - Generating graphs for audio and video processing.
-
-Nodes in the graph can be implemented as separate processes,
-communicating with sockets and exchanging multimedia content using fd
-passing.
-
-Building
---------
-
-Pipewire uses the Meson and Ninja build system to compile. If you're not
-familiar with these tools, the included "autogen.sh" script will
-automatically run the correct meson/ninja commands, and output a Makefile.
-It follows that there are two methods to build Pipewire, however both rely
-on Meson and Ninja to actually perform the compilation:
-
-$ ./autogen.sh
-$ make
-
-or the Meson/Ninja native method:
-
-$ meson build
-$ cd build
-$ ninja
-
-You can see the available meson options in meson_options.txt file.
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..3c4c0f9e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# PipeWire
+
+PipeWire is a server and user space API to deal with multimedia
+pipelines. This includes:
+
+  - Making available sources of video (such as from a capture devices or
+    application provided streams) and multiplexing this with
+    clients.
+  - Accessing sources of video for consumption.
+  - Generating graphs for audio and video processing.
+
+Nodes in the graph can be implemented as separate processes,
+communicating with sockets and exchanging multimedia content using fd
+passing.
+
+## Building
+
+Pipewire uses the Meson and Ninja build system to compile. You can run it
+with:
+
+```
+$ meson build
+$ cd build
+$ ninja
+```
+
+You can see the available meson options in `meson_options.txt` file.
+
+If you're not familiar with these tools, the included `autogen.sh` script will
+automatically run the correct `meson`/`ninja` commands, and output a Makefile.
+It follows that there are two methods to build Pipewire, however both rely
+on Meson and Ninja to actually perform the compilation:
+
+```
+$ ./autogen.sh
+$ make
+```
+
+## Running
+
+If you want to run PipeWire without installing it on your system, there is a
+script that you can run. This puts you in an environment in which PipeWire can
+be run from the build directory, and ALSA, PulseAudio and JACK applications
+will use the PipeWire emulation libraries automatically
+in this environment. You can get into this environment with:
+
+```
+$ ./pw-uninstalled.sh
+```