ref: 3ceeb1f13df99ca092eb463ea62904b97a085118
parent: 4ac52cd7304238d00090021d2db77e7fe8bdd6c1
author: Olav Sørensen <olav.sorensen@live.no>
date: Tue Nov 24 14:25:59 EST 2020
Update README.md
--- a/README.md
+++ b/README.md
@@ -1,6 +1,14 @@
# ft2play
-Bit-accurate C port of FT2.09's XM replayer (SB16/WAV render mode) \
-<i>NOTE: This is not the exact same replayer/mixer code used in the FT2 clone!</i> \
-\
-It contains an example program in the ft2play folder for how to interface with the API. \
-This has not been tested on other platforms than Windows, but it <i>should</i> compile on Linux and macOS!
+Bit-accurate C port of FT2.09's XM replayer (SB16/WAV render mode). \
+The project contains example code in the ft2play folder on how to interface with the API.
+
+# Notes
+- This is <i>not</i> the same replayer/mixer code used in the FT2 clone
+- The accuracy has only been compared against a few songs
+- The code may not be 100% safe for use as a replayer in other projects, and as such I recommend to use this only for reference
+
+# How to test accuracy
+1) Open FT2.08 or FT2.09 (use a fresh program start for every render) and load a song. Make sure "16-bit mixing", "Stereo" and "Interpolation" is enabled in the config screen.
+2) Save as WAV (freq=44100Hz, amp=4)
+3) Render the same song to WAV using ft2play (f.ex. "ft2play mysong.xm --render-to-wav")
+4) Use a program capable of verifying the binary integrity between the two output files. If they differ, you found a problem and should create a new issue for this project on github. :)