[pulseaudio-commits] [Git][pulseaudio/webrtc-audio-processing][master] doc: Add some build instructions to README

[Arun Raghavan]

Arun Raghavan pushed to branch master at PulseAudio / webrtc-audio-processing


Commits:
8ac052ad by Arun Raghavan at 2021-02-12T15:44:49-05:00
doc: Add some build instructions to README

- - - - -


1 changed file:

- README.md


Changes:

=====================================
README.md
=====================================
@@ -1,5 +1,4 @@
-About
-=====
+# About
 
 This is meant to be a more Linux packaging friendly copy of the AudioProcessing
 module from the [ WebRTC ](https://webrtc.googlesource.com/src) project. The
@@ -12,14 +11,32 @@ the code and hopefully eventually have a single point of packaging all the
 WebRTC code to help people reuse the code and avoid keeping private copies in
 several different projects.
 
-Feedback
-========
+# Building
+
+This project uses the [Meson build system](https://mesonbuild.com/). The
+quickest way to build is:
+
+```sh
+# Initialise into the build/ directory, for a prefixed install into the
+# install/ directory
+meson . build -Dprefix=$PWD/install
+
+# Run the actual build
+ninja -C build
+
+# Install locally
+ninja -C build install
+
+# The libraries, headers, and pkg-config files are now in the install/
+# directory
+```
+
+# Feedback
 
 Patches, suggestions welcome. You can file an issue on our Gitlab
 [repository](https://gitlab.freedesktop.org/pulseaudio/webrtc-audio-processing/).
 
-Notes
-====
+# Notes
 
 1. It might be nice to try LTO on the library. We build a lot of code as part
    of the main AudioProcessing module deps, and it's possible that this could



View it on GitLab: https://gitlab.freedesktop.org/pulseaudio/webrtc-audio-processing/-/commit/8ac052ad6ffd5ba1328c44160ec6571dfd9b930d

-- 
View it on GitLab: https://gitlab.freedesktop.org/pulseaudio/webrtc-audio-processing/-/commit/8ac052ad6ffd5ba1328c44160ec6571dfd9b930d
You're receiving this email because of your account on gitlab.freedesktop.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/pulseaudio-commits/attachments/20210212/cdb248f1/attachment-0001.htm>