Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the README.md file. #8

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
@@ -0,0 +1,42 @@
# ABOUT

File::ShareDir - Locate per-dist and per-module shared files

## SYNOPSIS

```
use File::ShareDir ':ALL';

# Where are distribution-level shared data files kept
$dir = dist_dir('File-ShareDir');

# Where are module-level shared data files kept
$dir = module_dir('File::ShareDir');

# Find a specific file in our dist/module shared dir
$file = dist_file( 'File-ShareDir', 'file/name.txt');
$file = module_file('File::ShareDir', 'file/name.txt');

# Like module_file, but search up the inheritance tree
$file = class_file( 'Foo::Bar', 'file/name.txt' );
```

# Installation

Use `cpan -i File::ShareDir` or cpanm/cpanp equivalent or your operating
system's package manager.

Alternatively, download the File::ShareDir tarball and do:

```
perl Makefile.PL
make
make test
sudo make install
```

# Links and more information

* [MetaCPAN](https://metacpan.org/release/File-ShareDir)
* [GitHub VCS Repository](https://github.com/perl5-utils/File-ShareDir)