Add a buncha documentation in index.html

1 files changed, 66 insertions, 0 deletions

diff --git a/index.html b/index.html
index e2df1ab..69b9a8e 100644
--- a/index.html
+++ b/index.html
@@ -35,6 +35,25 @@
             </article>
             <footer>
                 <details>
+                    <summary>How to play?</summary>
+                    <p>
+                        A word is shown above the textbox, where you try to guess which song the
+                        word came from. The textbox will guess what you mean (for example, typing
+                        "ho" narrows down the possibilities to House Of Gold, HOTY and Hometown).
+                    </p>
+                    <p>
+                        Press Enter to select the first song listed (it should work on mobile
+                        keyboards too, just beware of autocorrect), or just click on any of them.
+                    </p>
+                    <p>
+                        Click Next to see a new, random word.
+                        Click Hint to reveal which album the song is in (Self-Titled, RaB, RaB &amp;
+                        Vessel, Vessel, Blurryface, Trench, SAI, Single).
+                        Click Show Answer to reveal everything, including album, track, and the
+                        line(s) the word is taken from.
+                    </p>
+                </details>
+                <details>
                     <summary>List of songs included</summary>
                     <ul>
                         <li>All of Self-Titled</li>
@@ -49,6 +68,53 @@
                         <li>Level Of Concern</li>
                         <li>Christmas Saves The Year</li>
                     </ul>
+                    <p>These songs, however, are not included:</p>
+                    <ul>
+                        <li>Any of No Phun Intended</li>
+                        <li>Coconut Sharks in the Water</li>
+                        <li>"Mexico City Song", which apparently exists according to azlyrics but I never heard</li>
+                        <li>Can't Help Falling In Love (Elvis cover)</li>
+                        <li>Any cover other than Cancer</li>
+                        <li>The Hype (Berlin)</li>
+                    </ul>
+                </details>
+                <details>
+                    <summary>Disclaimer</summary>
+                    <p>
+                        "One tøp song" is made by fkfd entirely for entertainment purposes. I make
+                        absolutely no warranty. It is not a tool for gatekeeping. Not knowing
+                        lyrics to some tøp songs does not make you a fake fan (not knowing all,
+                        however, does). It is not a tool for scientific purposes either.
+                    </p>
+                    <p>
+                        Twenty One Pilots and/or Fueled By Ramen are copyright owners of both the
+                        lyrics and the album covers. Fair use or something I'm not American.
+                    </p>
+                </details>
+                <details>
+                    <summary>How are the words chosen?</summary>
+                    <p>
+                        I downloaded lyrics to all tøp songs from azlyrics.com with Python (which
+                        in retrospect seemed like a violation of their terms of service), saved
+                        them in .txt files, and wrote another Python script to locate words that
+                        appear in only one song.
+                    </p>
+                    <p>
+                        If inflections of the same word are found in any other song, all of them,
+                        including the original form, are removed (with a third Python script of
+                        course), unless they are semantically or phonetically distinguishable. The
+                        criteria for phonetically indistinguishable inflections are -s, -es, -d,
+                        -ed and -ing. However, if they only appear in one song, all inflections are
+                        preserved.
+                    </p>
+                    <p>
+                        For example, "sons" only appears in Addict With A Pen ("I haven't been the
+                        best of sons"), but because "son" appears in Taxi Cab, Clear, Polarize and
+                        No Chances, "sons" is removed from the dataset. "Weathered" (Chlorine) is
+                        semantically distinguishable from "weather" (Good Day, Migraine), so it is
+                        preserved. "Buy" (House of Gold) is phonetically distinguishable from
+                        "bought" (Car Radio, Levitate), so it is also preserved.
+                    </p>
                 </details>
             </footer>
         </div>