From 85b6d97b214e82613fe543090472cf72bb2a6b20 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Thu, 11 Jun 2020 21:18:32 +0200 Subject: [PATCH] Improve README --- README.md | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f4c5e10b5..3c8f05c4f 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ distribution package system. This ensures PipeWire is integrated into the rest of your system for the best experience. If you want to build and install PipeWire yourself, refer to -INSTALL.md for instructions. +[install](INSTALL.md) for instructions. ## Usage @@ -38,15 +38,15 @@ or with the provided scripts shown below. PipeWire can use environment variables to control the behaviour of applications: -* PIPEWIRE_DEBUG= to increase the debug level -* PIPEWIRE_LOG= to redirect log to filename -* PIPEWIRE_LATENCY= to configure latency -* PIPEWIRE_NODE= to request link to specified node +* `PIPEWIRE_DEBUG=` to increase the debug level +* `PIPEWIRE_LOG=` to redirect log to filename +* `PIPEWIRE_LATENCY=` to configure latency +* `PIPEWIRE_NODE=` to request link to specified node ### Using tools -pw-cat can be used to play and record audio and midi. Use pw-cat -h to get -some more help. There are some aliases like pw-play and pw-record to make +`pw-cat` can be used to play and record audio and midi. Use `pw-cat -h` to get +some more help. There are some aliases like `pw-play` and `pw-record` to make things easier: ``` @@ -60,13 +60,13 @@ JACK side-by-side or have PipeWire take over the functionality of JACK completely. In dual mode, JACK apps will by default use the JACK server. To direct a JACK -app to PipeWire, you can use the pw-jack script like this: +app to PipeWire, you can use the `pw-jack` script like this: ``` $ pw-jack ``` -If you replaced JACK with PipeWire completely, pw-jack does not have any +If you replaced JACK with PipeWire completely, `pw-jack` does not have any effect and can be ommited. ### Running PulseAudio applications @@ -76,7 +76,7 @@ PulseAudio side-by-side or have PipeWire take over the functionality of PulseAudio completely. We don't recommend to completely replace PulseAudio at this point. -Use the pw-pulse script to launch a PulseAudio application on PipeWire, like: +Use the `pw-pulse` script to launch a PulseAudio application on PipeWire, like: ``` $ pw-pulse @@ -90,13 +90,13 @@ If the PipeWire alsa module is installed, it can be seen with $ aplay -L ``` -Alsa application can then use the pipewire: device to use PipeWire +Alsa application can then use the `pipewire:` device to use PipeWire as the audio system. ### Running GStreamer applications -PipeWire includes 2 GStreamer elements called pipewiresrc and -pipewiresink. They can be used in pipelines like this: +PipeWire includes 2 GStreamer elements called `pipewiresrc` and +`pipewiresink`. They can be used in pipelines like this: ``` $ gst-launch-1.0 pipewiresrc ! videoconvert ! autovideosink @@ -120,20 +120,30 @@ automatically use the PipeWire video source when possible. ### Inspecting the PipeWire state There is currently no native graphical tool to inspect the PipeWire graph -but we recommend to use one of the excellent JACK tools, such as Carla, -catia, qjackctl,... You will not be able to see all features like the video +but we recommend to use one of the excellent JACK tools, such as `Carla`, +`catia`, `qjackctl`,... You will not be able to see all features like the video ports but it is a good start. -pw-mon dumps and monitors the state of the PipeWire daemon. +`pw-mon` dumps and monitors the state of the PipeWire daemon. -pw-dot can dump a graph of the pipeline, checkout out the help for +`pw-dot` can dump a graph of the pipeline, checkout out the help for how to do this. There is a more complicated tools to inspect the state of the server -with pw-cli. This tools can be used interactively or it can execute +with `pw-cli`. This tools can be used interactively or it can execute single commands like this to get the server information: ``` $ pw-cli info 0 ``` +## Contributing + +PipeWire is Free Software and is developed in the open. It is licensed under +the MIT license. + +Contributors are encouraged to submit merge requests or file bugs on gitlab, + +Join us on IRC at #pipewire on Freenode. + +We adhere to the Contributor Covenant for our [code of conduct](CODE_OF_CONDUCT.md).