diff --git a/README.md b/README.md index f1337b3..8244178 100644 --- 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:owenjow@berkeley.edu) – 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 the-rap-app@gmail.com! Although since I'll probably only check that email about two more times over the course of my existence, my [berkeley.edu email](mailto:owenjow@berkeley.edu) might be just a _slightly_ better contact option. diff --git a/index-nm.html b/index-nm.html index 1b95d87..141d400 100644 --- a/index-nm.html +++ b/index-nm.html @@ -5,7 +5,7 @@