mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-12-17 08:56:49 -05:00
doc: reorganize files
Separate various autogen files from the documentation .dox files. Rename .dox files to match the intended tree structure.
This commit is contained in:
parent
eca773fc12
commit
77fad4ee13
41 changed files with 60 additions and 59 deletions
47
doc/dox/tutorial/tutorial1.dox
Normal file
47
doc/dox/tutorial/tutorial1.dox
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
/** \page page_tutorial1 Tutorial - Part 1: Getting Started
|
||||
|
||||
|
||||
\ref page_tutorial "Index" | \ref page_tutorial2
|
||||
|
||||
In this tutorial we show the basics of a simple PipeWire application.
|
||||
Use this tutorial to get started and help you set up your development
|
||||
environment.
|
||||
|
||||
|
||||
# Initialization
|
||||
|
||||
Let get started with the simplest application.
|
||||
|
||||
\snippet tutorial1.c code
|
||||
|
||||
Before you can use any PipeWire functions, you need to call `pw_init()`.
|
||||
|
||||
|
||||
# Compilation
|
||||
|
||||
PipeWire provides a pkg-config file named `libpipewire-0.3` (note: the version
|
||||
suffix may change with future releases of PipeWire).
|
||||
To compile the simple test application, copy it into a test1.c file and
|
||||
use pkg-config to provide the required dependencies:
|
||||
|
||||
gcc -Wall test1.c -o test1 $(pkg-config --cflags --libs libpipewire-0.3)
|
||||
|
||||
then run it with:
|
||||
|
||||
# ./test1
|
||||
Compiled with libpipewire 0.3.5
|
||||
Linked with libpipewire 0.3.5
|
||||
#
|
||||
|
||||
Use your build system's pkg-config support to integrate it into your project.
|
||||
For example, a minimal [meson.build](https://mesonbuild.com/) entry would look
|
||||
like this:
|
||||
|
||||
project('test1', ['c'])
|
||||
pipewire_dep = dependency('libpipewire-0.3')
|
||||
executable('test1', 'test1.c',
|
||||
dependencies: [pipewire_dep])
|
||||
|
||||
\ref page_tutorial "Index" | \ref page_tutorial2
|
||||
|
||||
*/
|
||||
Loading…
Add table
Add a link
Reference in a new issue