From 3d260c45ed069410df1e9cc1e41e58dbf8ada1d3 Mon Sep 17 00:00:00 2001 From: Jean-Marc Valin Date: Fri, 1 Sep 2017 17:45:11 -0400 Subject: Adding a real README --- README | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README b/README index 40c23f9..38a3c56 100644 --- a/README +++ b/README @@ -1 +1,16 @@ -This project is highly experimental. Have fun, you're on your own for now. +RNNoise is a noise suppression library based on a recurrent neural network + +To compile, just type: +% ./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 input.pcm output.pcm + +The output is also a 16-bit raw PCM file. -- cgit v1.2.3