From cc2a838ab5b992df6bb8fa7b8321f0226094dedc Mon Sep 17 00:00:00 2001 From: Scott Baker Date: Thu, 25 Jan 2018 15:34:35 -0800 Subject: [PATCH] Update README to be Markdown for 2018 CPAN-PRC Convert text README to Markdown for better readability on Github. --- README => README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) rename README => README.md (76%) diff --git a/README b/README.md similarity index 76% rename from README rename to README.md index ba8b6c6..ce17207 100644 --- a/README +++ b/README.md @@ -1,25 +1,26 @@ -Scope-Guard version 0.21 -======================== +# Scope-Guard version 0.21 This module provides a convenient way to perform cleanup or other forms of resource management at the end of a scope. It is particularly useful when dealing with exceptions: -the Scope::Guard constructor takes a reference to a subroutine that is guaranteed to +the `Scope::Guard` constructor takes a reference to a subroutine that is guaranteed to be called even if the thread of execution is aborted prematurely. This effectively allows lexically-scoped "promises" to be made that are automatically honoured by perl's garbage collector. For more information, see: http://www.drdobbs.com/cpp/184403758 -INSTALLATION +### INSTALLATION To install this module, type the following: - perl Makefile.PL - make - make test - make install +``` +perl Makefile.PL +make +make test +make install +``` -COPYRIGHT AND LICENCE +### COPYRIGHT AND LICENCE Copyright (c) 2005-2015 by chocolateboy