README
1NAME
2 File::Share - Extend File::ShareDir to Local Libraries
3
4SYNOPSIS
5 use File::Share ':all';
6
7 my $dir = dist_dir('Foo-Bar');
8 my $file = dist_file('Foo-Bar', 'file.txt');
9
10DESCRIPTION
11 This module is a dropin replacement for File::ShareDir. It supports the
12 "dist_dir" and "dist_file" functions, except these functions have been
13 enhanced to understand when the developer's local "./share/" directory
14 should be used.
15
16 NOTE: module_dist and module_file are not yet supported, because (afaik)
17 there is no well known way to populate per-module share files. This may
18 change in the future. Please contact me if you know how to do this.
19
20PROBLEM AND SOLUTION
21 Module::Install has an "install_share" directive that allows you to
22 install various files associated with a distribution. By convention,
23 module authors always put these in a directory called "share/". However,
24 File::ShareDir can only find files after they have been installed. This
25 can be problematic when running development tests.
26
27 File::Share will look for a local "share" directory, if it notices that
28 the module corresponding was loaded from a development path.
29
30 Devel::Local gives you an easy way to use a bunch of source repositories
31 as though their lib and bin directories had already been installed.
32 "File::Share" lets you play along with that.
33
34SEE ALSO
35 * File::ShareDir
36
37AUTHOR
38 Ingy döt Net <ingy@cpan.org>
39
40COPYRIGHT AND LICENSE
41 Copyright 2011-2014. Ingy döt Net.
42
43 This program is free software; you can redistribute it and/or modify it
44 under the same terms as Perl itself.
45
46 See <http://www.perl.com/perl/misc/Artistic.html>
47
48