From c9a1fdbe647cc56e0a678c524a18b49110199e67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mads=20Kal=C3=B8r?= Date: Sat, 8 Feb 2014 12:01:32 +0100 Subject: [PATCH] Update README.md with dependencies and Rserve --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 832ff8c..4a15cac 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,14 @@ TwitVis is a tool for visualizing locations of tweets about a specific topic over time. The output is a number of images which can be used standalone or combined using `ffmpeg` to show the development as a video. +## Dependencies +ffmpeg, R and Ruby. + ## Usage +### Initialization +Before monitoring, an Rserve server must be started. This can be done using the simple `server.R` file: +`> R --vanilla -f 'server.R'` + ### Real-Time Monitoring For plotting tweets about 'sochi' and 'olympics' to the output directory `plots`: @@ -24,5 +31,5 @@ An optional frame rate can be given as the second argument (here a frame rate of `> ./mkvid.sh plots 10` -Example: +Example (single output frame): ![Example output](example.png)