Add more POD

[gruntmaster-daemon.git] / lib / Gruntmaster / Daemon / Runner / Interactive.pm

diff --git a/lib/Gruntmaster/Daemon/Runner/Interactive.pm b/lib/Gruntmaster/Daemon/Runner/Interactive.pm
index 2d2fe91cbe800be381aa8a681875c8674bc3f5ca..aea381a4bdfab70f76c33a11b3ea9ee98c077840 100644 (file)
--- a/lib/Gruntmaster/Daemon/Runner/Interactive.pm
+++ b/lib/Gruntmaster/Daemon/Runner/Interactive.pm
@@ -10,7 +10,7 @@ use Log::Log4perl qw/get_logger/;
 use POSIX qw/mkfifo/;
 use Try::Tiny;
 
-our $VERSION = '5999-TRIAL';
+our $VERSION = '5999.000_001';
 
 ##################################################
 
@@ -38,4 +38,38 @@ sub run{
   scalar slurp 'result'
 }
 
-1
+1;
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+Gruntmaster::Daemon::Runner::Interactive - Make an interactive verifier talk to the program
+
+=head1 SYNOPSIS
+
+  use Gruntmaster::Daemon::Runner::Interactive;
+  Gruntmaster::Daemon::Runner::Interactive->run(5, $meta);
+
+=head1 DESCRIPTION
+
+B<WARNING: This runner is experimental!>
+
+Gruntmaster::Daemon::Runner::Interactive is a runner which runs the program and an interactive verifier in parallel, connecting each program's STDIN to the other's STDOUT. The verifier, C<< $meta->{files}{int} >>, should return nonzero if the program gives an incorrect answer, and print the test score to fd 4 then return 0 if the answer is correct.
+
+=head1 AUTHOR
+
+Marius Gavrilescu E<lt>marius@ieval.roE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2014 by Marius Gavrilescu
+
+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.
+
+
+=cut