From: Marius Gavrilescu <marius@ieval.ro>
Date: Sat, 1 Feb 2014 23:00:30 +0000 (+0200)
Subject: Add README
X-Git-Tag: 5999.000_001~1
X-Git-Url: http://git.ieval.ro/?p=gruntmaster-data.git;a=commitdiff_plain;h=16f8d327cf18349155d53958612bef21dc85e5db

Add README
---

diff --git a/README b/README
index 0fa97a2..d3bd300 100644
--- a/README
+++ b/README
@@ -1,16 +1,9 @@
 Gruntmaster-Data version 5999.000_001
 =====================================
 
-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
+Gruntmaster-Data contains the Gruntmaster::Data module and associated tools.
 
-A README file is required for CPAN modules since CPAN extracts the
-README file from a module distribution so that people browsing the
-archive can use it get an idea of the modules uses. It is usually a
-good idea to provide version information here so that people can
-decide whether fixes for the module are worth downloading.
+Gruntmaster::Data is the Redis interface used by the Gruntmaster 6000 Online Judge.
 
 INSTALLATION
 
@@ -25,16 +18,19 @@ DEPENDENCIES
 
 This module requires these other modules and libraries:
 
-  blah blah blah
+* Date::Parse
+* File::Slurp
+* IO::Prompter
+* JSON
+* Redis
+* Sub::Name
+* Term::ANSIColor
 
 COPYRIGHT AND LICENCE
 
-Put the correct copyright and licence information here.
-
 Copyright (C) 2014 by Marius Gavrilescu
 
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself, either Perl version 5.18.2 or,
-at your option, any later version of Perl 5 you may have available.
-
-
+This library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.