NAME

liveman - "living manual". A utility for converting lib/**.md files into test files (t/**.t) and documentation (POD), which is placed in the corresponding module (lib/**.pm).

VERSION

Version 3.1

SYNOPSIS

liveman [-h] [--man] [-A pkg] [-o][-c][-f][-s][-a] [<files> ...]

DESCRIPTION

The problem with modern projects is that, who documentation is divorced from testing. This means, that the examples in the documentation may not work, and the documentation itself may lag behind the code.

The method of simultaneous documentation and testing solves this problem.

The md format was chosen for documentation as it is the easiest to enter and widely used. The sections of perl code described in it are translated into the test. And the documentation is translated into POD and added to the __END__ section of the perl module.

In other words, liveman converts lib/**.md-files into test files (t/**.t) and documentation, which is placed in the corresponding lib/**.pm module. And immediately runs tests with coverage.

The coverage can be viewed in the file cover_db/coverage.html.

Note: it is better to immediately place cover_db/ in .gitignore.

OPTIONS

-h, --help

Show help and exit.

--man

Print the manual and finish.

-o, --open

Open the coverage in your browser.

-c, --compile

Compile only, do not run tests.

-f, --force

Transform lib/**.md files even if they have not changed.

-p, --prove

Run tests in prove, not yath.

-o, --options OPTIONS

Pass a string with options to yath or prove. These options will be added to the default options.

Default options for yath:

yath test -j4 --cover

Default options for prove:

prove -Ilib -r t

-а, --append

Add function sections to *.md from *.pm and finish.

-A, --new PACKAGE [, LICENSE]

Creates a new repository. PACKAGE is the name of a new package, such as Aion::View.

Default LICENSE is perl_5. And it maybe gpl_3.

LICENSE

⚖ GPLv3

liveman Copyright (C) 2007 Yaroslav O. Kosmina <darviarush@mail.ru> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.

AUTHOR

Yaroslav O. Kosmina <darviarush@mail.ru>