Skip to content

Commit

Permalink
update repo layout and meta files
Browse files Browse the repository at this point in the history
Fixes #5
  • Loading branch information
xdg committed Feb 5, 2015
1 parent 411a78e commit 7992262
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 65 deletions.
37 changes: 12 additions & 25 deletions CONTRIBUTING.mkdn
Expand Up @@ -5,24 +5,21 @@ contains instructions that will help you work with the source code.

The distribution is managed with Dist::Zilla. This means than many of the
usual files you might expect are not in the repository, but are generated at
release time (e.g. Makefile.PL).
release time, as is much of the documentation. Some generated files are
kept in the repository as a convenience (e.g. Makefile.PL or cpanfile).

Generally, **you do not need Dist::Zilla to contribute patches**. You do need
Dist::Zilla to create a tarball and/or install from the repository. See below
for guidance.
Dist::Zilla to create a tarball. See below for guidance.

### Getting dependencies

See the included `cpanfile` file for a list of dependencies. If you have
App::cpanminus 1.6 or later installed, you can use `cpanm` to satisfy
dependencies like this:
If you have App::cpanminus 1.6 or later installed, you can use `cpanm` to
satisfy dependencies like this:

$ cpanm --installdeps .

Otherwise, you can install Module::CPANfile 1.0002 or later and then satisfy
dependencies with the regular `cpan` client and `cpanfile-dump`:

$ cpan `cpanfile-dump`
Otherwise, look for either a `Makefile.PL` or `cpanfile` file for
a list of dependencies to satisfy.

### Running tests

Expand All @@ -44,22 +41,16 @@ If there is a `tidyall.ini` file, you can also install Code::TidyAll and run

### Patching documentation

Much of the documentation Pod is generated at release time. Depending on the
distribution, some of my documentation may be written in a Pod dialect called
WikiDoc. (See Pod::WikiDoc on CPAN.)
Much of the documentation Pod is generated at release time. Some is
generated boilerplate; other documentation is built from pseudo-POD
directives in the source like C<=method> or C<=func>.

If you would like to submit a documentation edit, please limit yourself to the
documentation you see.
If you would like to submit a documentation edit, please limit yourself to
the documentation you see.

If you see typos or documentation issues in the generated docs, please
email or open a bug ticket instead of patching.

### Installing from the repository

If you want to install directly from the repository, you need to have
Dist::Zilla installed (see below). If this is a burden to you, I welcome
patches against a CPAN tarball instead of the repository.

### Installing and using Dist::Zilla

Dist::Zilla is a very powerful authoring tool, optimized for maintaining a
Expand Down Expand Up @@ -92,9 +83,5 @@ Once installed, here are some dzil commands you might try:
$ dzil test
$ dzil xtest

To install from the repository, use:

$ dzil install

You can learn more about Dist::Zilla at http://dzil.org/

4 changes: 4 additions & 0 deletions Changes
Expand Up @@ -2,6 +2,10 @@ Changes for File-chdir

{{ $NEXT }}

[Changed]

- Updated distribution metadata and repo layout

0.1009 2014-09-23 12:24:11-04:00 America/New_York

[Changed]
Expand Down
70 changes: 70 additions & 0 deletions Makefile.PL
@@ -0,0 +1,70 @@

# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.031.
use strict;
use warnings;

use 5.006;

use ExtUtils::MakeMaker 6.17;



my %WriteMakefileArgs = (
"ABSTRACT" => "a more sensible way to change directories",
"AUTHOR" => "David Golden <dagolden\@cpan.org>, Michael G. Schwern <schwern\@pobox.com>",
"CONFIGURE_REQUIRES" => {
"ExtUtils::MakeMaker" => "6.17"
},
"DISTNAME" => "File-chdir",
"EXE_FILES" => [],
"LICENSE" => "perl",
"MIN_PERL_VERSION" => "5.006",
"NAME" => "File::chdir",
"PREREQ_PM" => {
"Carp" => 0,
"Cwd" => "3.16",
"Exporter" => 0,
"File::Spec::Functions" => "3.27",
"strict" => 0,
"vars" => 0
},
"TEST_REQUIRES" => {
"ExtUtils::MakeMaker" => 0,
"File::Spec" => 0,
"Test::More" => 0,
"warnings" => 0
},
"VERSION" => "0.1010",
"test" => {
"TESTS" => "t/*.t"
}
);


my %FallbackPrereqs = (
"Carp" => 0,
"Cwd" => "3.16",
"Exporter" => 0,
"ExtUtils::MakeMaker" => "6.17",
"File::Spec" => 0,
"File::Spec::Functions" => "3.27",
"Test::More" => 0,
"strict" => 0,
"vars" => 0,
"warnings" => 0
);


unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) {
delete $WriteMakefileArgs{TEST_REQUIRES};
delete $WriteMakefileArgs{BUILD_REQUIRES};
$WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs;
}

delete $WriteMakefileArgs{CONFIGURE_REQUIRES}
unless eval { ExtUtils::MakeMaker->VERSION(6.52) };

WriteMakefile(%WriteMakefileArgs);



37 changes: 0 additions & 37 deletions cpanfile

This file was deleted.

3 changes: 1 addition & 2 deletions dist.ini
Expand Up @@ -5,6 +5,5 @@ license = Perl_5
copyright_holder = Michael G. Schwern and David Golden

[@DAGOLDEN]
:version = 0.068
github_issues = 0
:version = 0.072
stopwords = Warnock
3 changes: 2 additions & 1 deletion lib/File/chdir.pm
Expand Up @@ -3,7 +3,8 @@ use 5.004;
use strict;
use vars qw($VERSION @ISA @EXPORT $CWD @CWD);
# ABSTRACT: a more sensible way to change directories
# VERSION

our $VERSION = '0.1010';

require Exporter;
@ISA = qw(Exporter);
Expand Down

0 comments on commit 7992262

Please sign in to comment.