readme

README.md

@@ -2,6 +2,56 @@
 
 Build scripts for football.db, worldcup.db, bundesliga.db, etc.
 
+## Usage
+
+Use `rake -T`  to list all available tasks. Example:
+
+~~~
+$ rake -T
+~~~
+
+will print something like:
+
+~~~
+rake about     # print versions of gems
+rake book      # build book (draft version) - The Free Football World Almanac
+rake build     # build football.db from scratch (default)
+rake check     # check repo paths
+rake publish   # build book (release version) - The Free Football World Almanac
+rake pull      # pull (auto-update) football.db from upstream sources
+rake stats     # print stats for football.db tables/records
+rake update    # update football.db
+~~~
+
+
+## Examples
+
+Build the database for the World Cup in Brazil 2014 (from scratch):
+
+~~~
+rake build DATA=worldcup2014
+~~~
+
+Build the database for all the World Cups:
+
+~~~
+rake build DATA=worldcup
+~~~
+
+Build the database for the European Champions League 2013/14:
+
+~~~
+rake build DATA=cl201314
+~~~
+
+Update the database for the European Champions League 2013/14 (after updating your data sets from git):
+
+~~~
+rake update DATA=cl201314
+~~~
+
+And so on and so forth.
+
 
 ## License
 
@@ -14,3 +64,4 @@ Use it as you please with no restrictions whatsoever.
 Send them along to the
 [Open Sports & Friends Forum/Mailing List](http://groups.google.com/group/opensport).
 Thanks!
+

Rakefile

@@ -82,11 +82,18 @@ task :worldcup => :importbuiltin do
   SportDb.read_setup( 'setups/all',   WORLD_CUP_INCLUDE_PATH )
 end
 
+task :worldcup2014 => :importbuiltin do
+  SportDb.read_setup( 'setups/all',          NATIONAL_TEAMS_INCLUDE_PATH )
+  SportDb.read_setup( 'setups/2014_quali',   WORLD_CUP_INCLUDE_PATH )
+  SportDb.read_setup( 'setups/2014',         WORLD_CUP_INCLUDE_PATH )
+end
+
 task :worldcup2014q => :importbuiltin do
   SportDb.read_setup( 'setups/all',          NATIONAL_TEAMS_INCLUDE_PATH )
   SportDb.read_setup( 'setups/2014_quali',   WORLD_CUP_INCLUDE_PATH )
 end
 
+
 task :copaamerica => :importbuiltin do
   SportDb.read_setup( 'setups/all',   NATIONAL_TEAMS_INCLUDE_PATH )
   SportDb.read_setup( 'setups/all',   COPA_AMERICA_INCLUDE_PATH )