mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-10-29 05:40:27 -04:00
readme: Format in Markdown and add some more information
This commit is contained in:
parent
8409e8be49
commit
4cf66c00c0
2 changed files with 49 additions and 35 deletions
49
README.md
Normal file
49
README.md
Normal file
|
|
@ -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
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue