Added a README writeup (just to round things off!)

ohjay · Oct 30, 2015 · 8ff7c31 · 8ff7c31
1 parent 7d38b42
commit 8ff7c31
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
 # the-rap-app
-Real-time rap generator
+A real-time rap generator built at Cal Hacks 2015. Find it [here](https://www.ocf.berkeley.edu/~owenmj/) or, unofficially, at [ocf.sexy/owenmj](http://ocf.sexy/owenmj).
+
+_Note: As of October 30, 2015, only Chrome users can enjoy the full functionality of this website. This is due to the fact that our app uses the [Web Speech API](https://dvcs.w3.org/hg/speech-api/raw-file/tip/speechapi.html) to provide support for continuous voice recognition – unfortunately, Chrome seems to be the only browser that backs said specification._
+
+### What it does:
+Rap App processes speech input, where a break/pause signifies the end of a line. For every such line, it provides the user with a rhyme based on the final word in the given phrase. For example, if I were to say "_Yo yo yo my name is Jerry_," Rap App might respond with the word "hairy."
+
+The webpage also allows the user to select from five different instrumentals, so that everyone can rap to his/her beat of choice.
+
+### Why we made it:
+We wanted to make something cool and interactive. No, none of us can actually freestyle (...well). Also, a big shoutout to banana chips and coconut strips for inspiring this app in the first place!
+
+### How it works:
+Our "advanced" lookup algorithm searches for a rhyme by comparing IPA suffixes to each other (using pronunciation data from the [Moby Project](https://en.wikipedia.org/wiki/Moby_Project#Pronunciator)). These comparisons are made via methods on a trie, which is affectionately referred to as our "mobytrie." Yes, that was indeed relevant.
+
+The lookup function also sports a few other upgrades/optimizations, such that it can find a match for theoretically ANY word. If you any have questions about that, you can contact me at my [berkeley.edu email](mailto:[email protected]) – otherwise, feel free to take a look at the repo yourself!
+
+### Who contributed:
+Rap App was developed by three UC Berkeley students: Owen Jow, Sagang Wee, and Sam Choi.
+
+### W[h]ere you expecting anything else?
+If so, drop us a line at [email protected]! Although since I'll probably only check that email about two more times over the course of my existence, my [berkeley.edu email](mailto:[email protected]) might be just a _slightly_ better contact option.
diff --git a/index-nm.html b/index-nm.html
@@ -5,7 +5,7 @@
     <title>The Rap App</title>
 
     <link rel="stylesheet" href="css/style.min.css" />
-    <link href='http://fonts.googleapis.com/css?family=Roboto+Condensed' rel='stylesheet' type='text/css'>
+    <link href='//fonts.googleapis.com/css?family=Roboto+Condensed' rel='stylesheet' type='text/css'>
 </head>
 <body style="background-color: #000000">
     <!-- [ BEGIN MAIN BODY ] -->
@@ -183,7 +183,7 @@
     <script src="js/rhyme_lookup.min.js"></script>
     <script>
         var currentID = Number.MIN_SAFE_INTEGER;
-        var rhymes = ["Just start rapping!^2000"];
+        var rhymes = ["Just start rapping!^2500"];
         var updated = false;
 
         var newTyped = function(idStr) {