summaryrefslogtreecommitdiff
path: root/3rdparty/libwav/README.md
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/libwav/README.md')
-rw-r--r--3rdparty/libwav/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/3rdparty/libwav/README.md b/3rdparty/libwav/README.md
new file mode 100644
index 0000000..00560c5
--- /dev/null
+++ b/3rdparty/libwav/README.md
@@ -0,0 +1,46 @@
+# libwav
+
+libwav is a simple and tiny C library for reading or writing PCM wave (.wav)
+files.
+
+## Build and Install
+
+On Linux and macOS:
+
+ mkdir build
+ cd build
+ cmake [-DCMAKE_BUILD_TYPE=<Debug|Release|RelWithDebInfo>] ..
+ make
+ sudo make install
+
+On Windows:
+
+ mkdir build
+ cd build
+ cmake ..
+ cmake --build .
+
+## CMake Support
+
+Use `FetchContent`:
+
+ include(FetchContent)
+ FetchContent_Declare(libwav
+ GIT_REPOSITORY "https://github.com/brglng/libwav.git"
+ GIT_SHALLOW ON
+ )
+ FetchContent_MakeAvailable(libwav)
+ add_executable(yourprogram yourprogram.c)
+ target_link_libraries(yourprogram wav::wav)
+
+Use `add_subdirectory`:
+
+ add_subdirectory(libwav)
+ add_executable(yourprogram yourprogram.c)
+ target_link_libraries(yourprogram wav::wav)
+
+Use `find_package`:
+
+ find_package(wav)
+ add_executable(yourprogram yourprogram.c)
+ target_link_libraries(yourprogram wav::wav)