From ef1195d9dc3ae575691a6ede10eb801c71a193a1 Mon Sep 17 00:00:00 2001 From: Kelly Rauchenberger Date: Mon, 9 Jan 2017 17:03:01 -0500 Subject: Wrote readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..5fc7b1e --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# cadence + +`cadence` is a Twitter bot that says things about random songs based on their characteristics. + +The data that `cadence` uses to characterize songs comes from the [AcousticBrainz](https://acousticbrainz.org/) project. AcousticBrainz does not currently have an API that would facilitate randomly picking a song, so this bot uses a specially generated datafile that allows it to both randomly choose a song, and identify the type of song it is. Included in this respository is the source of a generator program that can create this datafile from a dump of the AcousticBrainz database. + +`cadence` depends on [yaml-cpp](https://github.com/jbeder/yaml-cpp) to read configuration data from a file, SQLite3 to read a datafile, and my own library [libtwitter++](https://github.com/hatkirby/libtwittercpp) to post to Twitter. + +The canonical bot, [@songchoicebot](https://twitter.com/songchoicebot), uses the categorization of random songs in order to say things that are ill-fitted to describe the song. -- cgit 1.4.1