summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJean-Marc Valin <jmvalin@jmvalin.ca>2017-09-01 17:45:11 -0400
committerJean-Marc Valin <jmvalin@jmvalin.ca>2017-09-01 17:45:11 -0400
commit3d260c45ed069410df1e9cc1e41e58dbf8ada1d3 (patch)
tree63a73275a77b495acaf4910c0a55c7e771098479
parentbf43874d336c21d5b5945e8b200242f8d1852f82 (diff)
downloadrnnoise-3d260c45ed069410df1e9cc1e41e58dbf8ada1d3.tar.gz
rnnoise-3d260c45ed069410df1e9cc1e41e58dbf8ada1d3.tar.bz2
rnnoise-3d260c45ed069410df1e9cc1e41e58dbf8ada1d3.zip
Adding a real 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.