Blame README.mkdn

Packit 207d94
# NAME
Packit 207d94
Packit 207d94
Test::InDistDir - test environment setup for development with IDE
Packit 207d94
Packit 207d94
# VERSION
Packit 207d94
Packit 207d94
version 1.112071
Packit 207d94
Packit 207d94
# SYNOPSIS
Packit 207d94
Packit 207d94
    use Test::More;
Packit 207d94
    use Test::InDistDir;
Packit 207d94
Packit 207d94
    # when this is run from inside t/ with a default @INC, it will now be in the
Packit 207d94
    # dist dir and include ./lib in @INC
Packit 207d94
Packit 207d94
# DESCRIPTION
Packit 207d94
Packit 207d94
This module helps run test scripts in IDEs like Komodo.
Packit 207d94
Packit 207d94
When running test scripts in an IDE i have to set up a project file defining the
Packit 207d94
dist dir to run tests in and a lib dir to load additional modules from. Often I
Packit 207d94
didn't feel like doing that, especially when i only wanted to do a small patch
Packit 207d94
to a dist. In those cases i added a BEGIN block to mangle the environment for
Packit 207d94
me.
Packit 207d94
Packit 207d94
This module basically is that BEGIN block. It automatically moves up one
Packit 207d94
directory when it cannot see the test script in "t/$scriptname" and includes
Packit 207d94
'lib' in @INC when there's no blib present. That way the test ends up with
Packit 207d94
almost the same environment it'd get from EUMM/prove/etc., even when it's
Packit 207d94
actually run inside the t/ directory.
Packit 207d94
Packit 207d94
At the same time it will still function correctly when called by
Packit 207d94
EUMM/prove/etc., since it does not change the environment in those cases.
Packit 207d94
Packit 207d94
# SUPPORT
Packit 207d94
Packit 207d94
## Bugs / Feature Requests
Packit 207d94
Packit 207d94
Please report any bugs or feature requests by email to `bug-test-indistdir at rt.cpan.org`, or through
Packit 207d94
the web interface at [http://rt.cpan.org/Public/Dist/Display.html?Name=Test-InDistDir](http://rt.cpan.org/Public/Dist/Display.html?Name=Test-InDistDir). You will be automatically notified of any
Packit 207d94
progress on the request by the system.
Packit 207d94
Packit 207d94
## Source Code
Packit 207d94
Packit 207d94
This is open source software.  The code repository is available for
Packit 207d94
public review and contribution under the terms of the license.
Packit 207d94
Packit 207d94
[https://github.com/wchristian/Test-InDistDir](https://github.com/wchristian/Test-InDistDir)
Packit 207d94
Packit 207d94
  git clone https://github.com/wchristian/Test-InDistDir
Packit 207d94
Packit 207d94
# AUTHOR
Packit 207d94
Packit 207d94
Christian Walde <walde.christian@googlemail.com>
Packit 207d94
Packit 207d94
# COPYRIGHT AND LICENSE
Packit 207d94
Packit 207d94
This software is Copyright (c) 2011 by Christian Walde.
Packit 207d94
Packit 207d94
This is free software, licensed under:
Packit 207d94
Packit 207d94
  DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE, Version 2, December 2004