Add license and readme

Author: nathanntg

LICENSE.txt

@@ -0,0 +1,115 @@
+                        THE CRAPL v0 BETA 1
+
+
+0. Information about the CRAPL
+
+If you have questions or concerns about the CRAPL, or you need more
+information about this license, please contact:
+
+   Matthew Might
+   http://matt.might.net/
+
+
+I. Preamble
+
+Science thrives on openness.
+
+In modern science, it is often infeasible to replicate claims without
+access to the software underlying those claims.
+
+Let's all be honest: when scientists write code, aesthetics and
+software engineering principles take a back seat to having running,
+working code before a deadline.
+
+So, let's release the ugly.  And, let's be proud of that.
+
+
+II. Definitions
+
+1. "This License" refers to version 0 beta 0 of the Community
+    Research and Academic Programming License (the CRAPL). 
+
+2. "The Program" refers to the medley of source code, shell scripts,
+    executables, objects, libraries and build files supplied to You,
+    or these files as modified by You.
+
+   [Any appearance of design in the Program is purely coincidental and
+    should not in any way be mistaken for evidence of thoughtful
+    software construction.]
+
+3. "You" refers to the person or persons brave and daft enough to use
+    the Program.
+
+4. "The Documentation" refers to the Program.
+
+5. "The Author" probably refers to the caffeine-addled graduate
+    student that got the Program to work moments before a submission
+    deadline.
+
+
+III. Terms
+
+1. By reading this sentence, You have agreed to the terms and
+   conditions of this License.
+  
+2. If the Program shows any evidence of having been properly tested
+   or verfied, You will disregard this evidence.
+
+3. You agree to hold the Author free from shame, embarrassment or
+   ridicule for any hacks, kludges or leaps of faith found within the
+   Program.
+
+4. You recognize that any request for support for the Program will be
+   discarded with extreme prejudice.
+
+5. The Author reserves all rights to the Program, except for any
+   rights granted under any additional licenses attached to the
+   Program.
+
+
+IV. Permissions
+
+1. You are permitted to use the Program to validate published
+   scientific claims.
+
+2. You are permitted to use the Program to validate scientific claims
+   submitted for peer review, under the condition that You keep
+   modifications to the Program confidential until those claims have
+   been published.
+ 
+3. You are permitted to use and/or modify the Program for the
+   validation of novel scientific claims if You make a good-faith
+   attempt to notify the Author of Your work and Your claims prior to
+   submission for publication.
+ 
+4. If You publicly release any claims or data that were supported or
+   generated by the Program or a modification thereof, in whole or in
+   part, You will release any inputs supplied to the Program and any
+   modifications You made to the Progam.  This License will be in
+   effect for the modified program.
+
+
+V. Disclaimer of Warranty
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+
+VI. Limitation of Liability
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

README.md

@@ -0,0 +1,34 @@
+# Syllable Detector - MATLAB implementation
+
+The syllable detector is a MATLAB program that uses the DSP functionality
+to perform low-latency syllable detection based on a simple neural network
+trained using the [training code](https://github.com/gardner-lab/syllable-detector-learn)
+created by @bwpearre. Detection events result in a TTL pulse that can be generated
+either on an audio channel or via an Arduino (pin 7). For the Arduino output, see the
+[arduino branch](https://github.com/gardner-lab/syllable-detector-matlab/tree/arduino).
+
+This detector is less performant than the 
+[Swift implementation](https://raw.githubusercontent.com/gardner-lab/syllable-detector-swift),
+but offers a cross-platform solution with lower barriers to entry and more flexibility
+for debugging. Performance an be tuned by adjusting the buffer size for input and output,
+but lowering these values too much (less than 2-5ms) can result in buffer overruns and
+underruns, that will hurt accuracy.
+
+Note that the MATLAB implementation may not support all the same normalization options that are available in the training code and Swift implementation.
+
+To start the detector, use the `nndetector_live` command. You will be prompted to
+select what input and output devices to use, as well as for a ".mat" file containing
+a trained detector.
+
+You can include parameters when calling the `nndetector_live` command. For example, to
+tune the audio buffer sizes to 2ms, use the following command:
+
+```
+nndetector_live('buffer_size_input', 0.002, 'buffer_size_output', 0.002);
+```
+
+This code requies the Data Acquisition Toolbox and the Parallel Computing Toolbox.
+
+This code was created by Jeffrey Markowitz @jmarkow, and underwent minor modifications
+to optimize performance (using "spmd" from the Parallel toolbox) by L. Nathan Perkins
+@nathanntg.