Skip to content

Commit

Permalink
Convert README to markdown
Browse files Browse the repository at this point in the history
This is the format used most often on GitHub when introducing a software
package to potential users and developers, and allows for simple formatting
of the README document.  As part of this change I added headers for
installation and documentation sections.
  • Loading branch information
paultcochrane committed Oct 22, 2015
1 parent bc35246 commit 9b2481d
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 21 deletions.
21 changes: 0 additions & 21 deletions README

This file was deleted.

23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Test::MockModule - mock subroutines in a module

See the LICENSE section in `lib/Test/MockModule.pm` for usage and
distribution rights.

## Installation

Run these commands in the source directory:

perl Build.PL
./Build
./Build test
./Build install

Then delete the source directory tree since it's no longer needed.

Alternatively, you can simply install the module via `cpanm`:

cpanm Test::MockModule

## Documentation

Run `perldoc Test::MockModule` to read the full documentation.

0 comments on commit 9b2481d

Please sign in to comment.