aboutsummaryrefslogtreecommitdiff
path: root/audio/tuneit/README
diff options
context:
space:
mode:
Diffstat (limited to 'audio/tuneit/README')
-rw-r--r--audio/tuneit/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/audio/tuneit/README b/audio/tuneit/README
new file mode 100644
index 000000000000..22a32065036b
--- /dev/null
+++ b/audio/tuneit/README
@@ -0,0 +1,17 @@
+tuneit (A simple command-line instrument tuner)
+
+Tune-it uses two different algorithms for pitch detection. By default,
+a simple and fast Schmitt Trigger based algorithm is used to detect the
+fundamental frequency of an instrument. For better and more reliable
+results, there is an alternative FFT based algorithm which is much more
+CPU intensive.
+
+As audio capture backends, ALSA and JACK are supported. By default, tuneit
+will try to use the hw:0,0 ALSA device.
+
+This requires fftw. jack is an optional dependency, but enabled by default
+in this build script. If you don't want jack support, then run the script
+with USE_JACK=no in the build environment.
+
+Tip: Unless you're on a really slow ancient system, you probably want
+to always run tuneit with the -f option.