From 9de5b16847aa641af60507a3c1e70e7d312be36b Mon Sep 17 00:00:00 2001
From: Jamie Hardt <jamiehardt@me.com>
Date: Fri, 20 Nov 2020 12:12:51 -0800
Subject: [PATCH] Moved some documenation into README

---
 README.md         | 34 +++++++++++++++++++++++++++++++++-
 src/wavereader.rs | 31 +------------------------------
 2 files changed, 34 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index ad315b0..88a9621 100644
--- a/README.md
+++ b/README.md
@@ -31,4 +31,36 @@ while( frame_reader.read_integer_frame(&mut buffer) > 0) {
 All of the media for the integration tests is committed to the respository
 in either zipped form or is created by ffmpeg. Before you can run tests,
 you need to `cd` into the `tests` directory and run the `create_test_media.sh`
-script.
\ No newline at end of file
+script.
+
+## Resources
+
+ 
+### Implementation of Broadcast Wave Files
+  - [EBU Tech 3285][ebu3285] (May 2011), "Specification of the Broadcast Wave Format (BWF)"
+
+
+### Implementation of 64-bit Wave Files
+  - [ITU-R 2088][itu2088] (October 2019), "Long-form file format for the international exchange of audio programme materials with metadata"
+    - Presently in force, adopted by the EBU in [EBU Tech 3306v2][ebu3306v2] (June 2018).
+  
+    - [EBU Tech 3306v1][ebu3306v1] (July 2009), "MBWF / RF64: An extended File Format for Audio"
+    - No longer in force, however long-established. 
+
+
+### Implementation of Wave format `fmt` chunk
+  - [MSDN WAVEFORMATEX](https://docs.microsoft.com/en-us/windows/win32/api/mmeapi/ns-mmeapi-waveformatex)
+  - [MSDN WAVEFORMATEXTENSIBLE](https://docs.microsoft.com/en-us/windows/win32/api/mmreg/ns-mmreg-waveformatextensible)
+
+
+### Other resources
+- [RFC 3261][rfc3261] (June 1998) "WAVE and AVI Codec Registries" 
+- [Peter Kabal, McGill University](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)
+  - [Multimedia Programming Interface and Data Specifications 1.0](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/Docs/riffmci.pdf) 
+    IBM Corporation and Microsoft Corporation, (August 1991)
+
+[ebu3285]:  https://tech.ebu.ch/docs/tech/tech3285.pdf
+[ebu3306v1]: https://tech.ebu.ch/docs/tech/tech3306v1_1.pdf
+[ebu3306v2]:  https://tech.ebu.ch/docs/tech/tech3306.pdf
+[itu2088]:  https://www.itu.int/dms_pubrec/itu-r/rec/bs/R-REC-BS.2088-1-201910-I!!PDF-E.pdf
+[rfc3261]:  https://tools.ietf.org/html/rfc2361
\ No newline at end of file
diff --git a/src/wavereader.rs b/src/wavereader.rs
index fe762ab..b9883b6 100644
--- a/src/wavereader.rs
+++ b/src/wavereader.rs
@@ -16,36 +16,7 @@ use std::io::{Read, Seek};
 /**
  * Wave, Broadcast-WAV and RF64/BW64 parser/reader.
  * 
- * ## Resources
- * 
- * ### Implementation of Broadcast Wave Files
- *   - [EBU Tech 3285][ebu3285] (May 2011), "Specification of the Broadcast Wave Format (BWF)"
- * 
- * 
- * ### Implementation of 64-bit Wave Files
- *   - [ITU-R 2088][itu2088] (October 2019), "Long-form file format for the international exchange of audio programme materials with metadata"
- *     - Presently in force, adopted by the EBU in [EBU Tech 3306v2][ebu3306v2] (June 2018).
- *   
- *   - [EBU Tech 3306v1][ebu3306v1] (July 2009), "MBWF / RF64: An extended File Format for Audio"
- *     - No longer in force, however long-established. 
- * 
- * 
- * ### Implementation of Wave format `fmt` chunk
- *   - [MSDN WAVEFORMATEX](https://docs.microsoft.com/en-us/windows/win32/api/mmeapi/ns-mmeapi-waveformatex)
- *   - [MSDN WAVEFORMATEXTENSIBLE](https://docs.microsoft.com/en-us/windows/win32/api/mmreg/ns-mmreg-waveformatextensible)
- * 
- * 
- * ### Other resources
- * - [RFC 3261][rfc3261] (June 1998) "WAVE and AVI Codec Registries" 
- * - [Peter Kabal, McGill University](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)
- *   - [Multimedia Programming Interface and Data Specifications 1.0](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/Docs/riffmci.pdf) 
- *     IBM Corporation and Microsoft Corporation, (August 1991)
- * 
- * [ebu3285]:  https://tech.ebu.ch/docs/tech/tech3285.pdf
- * [ebu3306v1]: https://tech.ebu.ch/docs/tech/tech3306v1_1.pdf
- * [ebu3306v2]:  https://tech.ebu.ch/docs/tech/tech3306.pdf
- * [itu2088]:  https://www.itu.int/dms_pubrec/itu-r/rec/bs/R-REC-BS.2088-1-201910-I!!PDF-E.pdf
- * [rfc3261]:  https://tools.ietf.org/html/rfc2361
+
 */
 #[derive(Debug)]
 pub struct WaveReader<R: Read + Seek> {