aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..88fc79c
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+RNNoise is a noise suppression library based on a recurrent neural network.
+
+To compile, just type:
+% ./autogen.sh
+% ./configure
+% make
+
+Optionally:
+% make install
+
+While it is meant to be used as a library, a simple command-line tool is
+provided as an example. It operates on RAW 16-bit (machine endian) mono
+PCM files sampled at 48 kHz. It can be used as:
+
+./examples/rnnoise_demo <number of channels> <maximum attenuation> < input.raw > output.raw
+
+The output is also a 16-bit raw PCM file.