From 49313bdfc9fabee487db02b781b97aa4501822e8 Mon Sep 17 00:00:00 2001 From: Aaron Gutierrez Date: Mon, 27 Dec 2021 18:15:25 -0800 Subject: [PATCH] Documentation --- README | 3 --- README.md | 23 +++++++++++++++++++++++ 2 files changed, 23 insertions(+), 3 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index e8fb352..0000000 --- a/README +++ /dev/null @@ -1,3 +0,0 @@ -Prototype instrument tuner - -Why? Why not diff --git a/README.md b/README.md new file mode 100644 index 0000000..bcba9b1 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# HTML + JavaScript instrument tuner +--- +## What +A simple webapp that listens to your microphone, figures out what note you are trying to play, and +tells you if that note is in tune. + +## Why + - All the free instrument tuner apps seem to have ads + - Fast Fourier Transforms seemed interesting + - I was bored + +## How +This makes use of the Web Audio API's +[`AnalyserNode`](https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode). I figured all the +bits and pieces out following this [MDN +tutorial](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Visualizations_with_Web_Audio_API) + +## Where +Hosted: [tuner.frat.tech](https://tuner.frat.tech) +Source: [aarongut/tuner](https://github.com/aarongut/tuner) + +## Who +[Aaron Gutierrez](https://aarongutierrez.com)