diff --git a/README.md b/README.md index dcbe22cbd..a7659529b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # PipeWire -PipeWire is a server and user space API to deal with multimedia -pipelines. This includes: +[PipeWire](https://pipewire.org) 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 @@ -137,6 +137,12 @@ single commands like this to get the server information: $ pw-cli info 0 ``` +## Documentation + +Find tutorials and design documentation [here](doc/index.md). + +The autogenerated API docs are [here](https://docs.pipewire.org). + ## Contributing PipeWire is Free Software and is developed in the open. It is licensed under diff --git a/doc/index.md b/doc/index.md index d230a75b1..be2f220b6 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,4 +1,4 @@ -# PipeWire +# PipeWire Documentation Start with the [overview](overview.md) of PipeWire.