From e78bf3a0dc29a2e92f8c65207e4dd1582bf270c9 Mon Sep 17 00:00:00 2001
From: Quantum <quantum2048@gmail.com>
Date: Tue, 17 Dec 2019 22:18:27 -0500
Subject: [PATCH] Add README

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..796b028
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# `winscap`
+
+Windows raw sound output capture tool.
+
+## Usage
+
+You tell `winscap` how many channels and bits to capture at what sampling rate:
+
+    winscap <channels> <sample rate> <bits per sample>
+
+`winscap` will output a raw PCM stream (signed little-endian) to stdout.
+
+Note that `winscap` uses your audio device in shared mode, so your capture settings
+must match the Windows output device. By default, this is 16-bit stereo at 48000 Hz.
+If your capture settings do not match, `winscap` will fail to start.
+
+## Building
+
+You need a new enough Visual C++ toolchain. To build, run
+
+    nmake
+
+## Background
+
+I created this tool as a lightweight approach to run [Cava][1] on Windows Subsystem
+for Linux (WSL) while using sound output from Windows.
+
+To use with Cava, configure Cava to read from a named pipe inside WSL (we'll use
+`/tmp/cava.fifo` in this example) with the following configuration:
+
+```ini
+[input]
+method = fifo
+source = /tmp/cava.fifo
+sample_rate = 48000
+```
+
+Replace `48000` with whatever sampling rate you use with `winscap`.
+
+Then, run `winscap` as follows:
+
+```sh
+$ /mnt/c/path/to/winscap.exe 2 48000 16 > /tmp/cava.fifo
+```
+
+Again, replace the arguments as appropriate.
+
+  [1]: https://github.com/karlstav/cava