From b2a56c980ec6f9f32b94c9bd9294da2a1e9aef7c Mon Sep 17 00:00:00 2001 From: Kelly Rauchenberger Date: Tue, 19 Jan 2016 10:00:31 -0500 Subject: the furries are self-documenting --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..30d30e7 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# furries +furries is a simple twitter bot inspired by the following image: + +![the furries are back](http://www.wtae.com/image/view/-/20831998/highRes/1/-/maxh/630/maxw/1200/-/tyl7ng/-/img-The-Furries-Are-Back-Who-Are-They.jpg) + +It tweets something that the furries are every three hours. Currently, it uses the [WordNet database](http://wordnet.princeton.edu/wordnet/) to pick adjectives and adverbs describing the furries. + +The bot uses [YAMLcpp](https://github.com/jbeder/yaml-cpp) to read a configuration file, MySQL C API to read the WordNet database (seeded with [this MySQL version of WordNet 2.0](androidtech.com/html/wordnet-mysql-20.php)), and [twitcurl](https://github.com/swatkat/twitcurl) to send the status updates to Twitter. + +The canonical furries handle is [@thefurriesare](https://twitter.com/thefurriesare). -- cgit 1.4.1