Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mumble-voip/rnnoise.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 16 insertions, 1 deletions
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.