[whimsy.git] [2/37] Commit 1a4e459: docs

[Sam Ruby <ru...@apache.org>]

Commit 1a4e4597dd964a35505baa71edc4244dfdd97ac1:
    docs


Branch: refs/heads/secmail
Author: Sam Ruby <ru...@intertwingly.net>
Committer: Sam Ruby <ru...@intertwingly.net>
Pusher: rubys <ru...@apache.org>

------------------------------------------------------------
README                                                       | +++++++++++++++ 
Rakefile                                                     | ++++++++++++ --
------------------------------------------------------------
29 changes: 27 additions, 2 deletions.
------------------------------------------------------------


diff --git a/README b/README
new file mode 100644
index 0000000..10001c2
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+This directory contains a script that fetches and parsed secretary emails
+and a server that will enable exploration of those emails.
+
+Usage:
+
+  rake fetch
+  rake server
+
+Notes:
+
+  First fetch and parse will take approximately an hour, even with a relatively
+  fast machine and internet connection.  Subsequent fetches will take as
+  little as ten seconds or less.
+
+  Secretary email archive currently requires about approximately 11 Gigabytes.
diff --git a/Rakefile b/Rakefile
index 859fdd3..6e2498c 100644
--- a/Rakefile
+++ b/Rakefile
@@ -1,13 +1,23 @@
 verbose false
 
+task :default do
+  puts 'Usage:'
+  sh 'rake', '-T'
+end
+
 file 'Gemfile.lock' => 'Gemfile' do
   sh 'bundle update'
 end
 
-task :parse => 'Gemfile.lock' do
+desc 'install dependencies'
+task :bundle => 'Gemfile.lock'
+
+desc 'Parse emails'
+task :parse => :bundle do
   ruby 'parsemail.rb'
 end
 
-task :fetch => 'Gemfile.lock' do
+desc 'Fetch and parse emails'
+task :fetch => :bundle do
   ruby 'parsemail.rb', '--fetch'
 end