aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Feist <shabble@metavore.org>2011-04-18 07:36:21 +0000
committerTom Feist <shabble@metavore.org>2011-04-18 07:36:21 +0000
commitb659b7ec8d3875f714af977cdf92844a9e303e21 (patch)
tree4c666a4593e90ff0aaaff9a5733b6c8b81a02db8
parentido-mode: final fixup. Stupidly missing =back in lists. (diff)
downloadirssi-scripts-b659b7ec8d3875f714af977cdf92844a9e303e21.tar.gz
irssi-scripts-b659b7ec8d3875f714af977cdf92844a9e303e21.zip
readme: fixed generator to not stomp if multiple files in one dir. Doesn't
auto-display though. Maybe need to generate an index? (But where to store it?)
-rw-r--r--feature-tests/template.pl77
-rw-r--r--readme_generator.pl9
2 files changed, 58 insertions, 28 deletions
diff --git a/feature-tests/template.pl b/feature-tests/template.pl
index 3cb7b61..a49d742 100644
--- a/feature-tests/template.pl
+++ b/feature-tests/template.pl
@@ -1,30 +1,53 @@
-# DOCUMENTATION:
-#
-#
-#
-#
-# LICENCE:
-#
-# Copyright (c) 2011 Tom Feist <shabble+irssi@metavore.org>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
+=pod
+
+=head1 NAME
+
+template.pl
+
+=head1 DESCRIPTION
+
+A minimalist template useful for basing actual scripts on.
+
+=head1 INSTALLATION
+
+Copy into your F<~/.irssi/scripts/> directory and load with
+C</SCRIPT LOAD F<filename>>.
+
+=head1 USAGE
+
+None, since it doesn't actually do anything.
+
+=head1 AUTHORS
+
+Copyright E<copy> 2011 Tom Feist C<E<lt>shabble+irssi@metavore.orgE<gt>>
+
+=head1 LICENCE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+=head1 BUGS
+
+=head1 TODO
+
+Use this template to make an actual script.
+
+=cut
use strict;
use warnings;
diff --git a/readme_generator.pl b/readme_generator.pl
index 5a997e4..dc3b277 100644
--- a/readme_generator.pl
+++ b/readme_generator.pl
@@ -43,7 +43,14 @@ sub read_input_file {
close $rfh;
- create_output_file($dir, 'README.md', $parser);
+ my @other_files = glob($dir . "/*.pl");
+
+ if (@other_files > 1) {
+ $filename =~ s/\.pl$//;
+ create_output_file($dir, "README-$filename.md", $parser);
+ } else {
+ create_output_file($dir, "README.md", $parser);
+ }
}
sub create_output_file {