From 60cefc2a85a5b0c90d39cf802587b99695b6f6b2 Mon Sep 17 00:00:00 2001 From: Nathan Perkins Date: Tue, 3 Nov 2015 12:56:32 -0500 Subject: [PATCH] Add readme and license. --- LICENSE | 19 +++++++++++++++++++ README.md | 9 +++++++++ 2 files changed, 28 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..99de485 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2015 L. Nathan Perkins + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bbf3a40 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +Syllable Detector +================= + +The syllable detector is a Mac app that uses CoreAudio to perform low-latency +syllable detection based on a simple Matlab neural network trained using the +[training code](https://github.com/bwpearre/birds/blob/master/align/learn_detector.m) +created by @bwpearre. Audio sampling is highly tunable to tradeoff between detection +latency/jitter and processing power. The app allows running multiple detectors through +multiple audio devices and/or channels.