Skip to content

Commit b211056

Browse files
author
Chris White
committed
Cleanup to prep for release
- `clean` target also deletes ./fatlib - Remove `Makefile-premodule` now that it has been integrated into Makefile.PL - Fill in Changes - Update installation instructions in README
1 parent f665bda commit b211056

File tree

8 files changed

+30
-37
lines changed

8 files changed

+30
-37
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
/fatlib
44
/stuff
55

6+
# Dist
7+
/Text-PerlPP*
8+
69
# Editor
710
*.bak
811
*~

Changes

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Revision history for Text-PerlPP
22

3-
0.01 Date/time
4-
First version, released on an unsuspecting world.
3+
0.3.1 2018/05/11
4+
First CPAN version, released on an unsuspecting world.
55

MANIFEST

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ LICENSE
55
Makefile.PL
66
MANIFEST This list of files
77
MANIFEST.SKIP
8+
pack.PL Script to make the packed version
89
README
910
README.md The tutorial
1011
t/00-load.t

Makefile-premodule

Lines changed: 0 additions & 24 deletions
This file was deleted.

Makefile.PL

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ WriteMakefile(
3939
'Getopt::Long' => '2.50', # Per issue #17
4040
},
4141
dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
42-
clean => { FILES => 'Text-PerlPP-*' },
42+
clean => { FILES => 'Text-PerlPP-* fatlib' },
4343
);
4444
# vi: set ts=4 sts=4 sw=4 et ai: #

README

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Text-PerlPP
1+
Text-PerlPP - a Perl preprocessor
22

33
Translates text files with embedded Perl code to plain text files.
44
See README.md for details. A simple example:
@@ -22,15 +22,28 @@ https://github.com/interpreters/perlpp/releases
2222

2323
INSTALLATION
2424

25-
To install this module, run the following commands:
25+
Easy installation, using App::cpanminus:
2626

27-
perl Makefile.PL
28-
make
29-
make test
30-
make install
27+
cpanm Text::PerlPP
3128

32-
... or simply copy lib/Text/PerlPP.pm to a directory in your @INC, and
33-
bin/perlpp to a directory in your PATH.
29+
Easy installation, using the release from GitHub:
30+
31+
- Copy the release file to a directory in your PATH
32+
33+
Slightly less easy installation, using ExtUtils::MakeMaker:
34+
35+
- Unpack the tarball
36+
- In the resulting directory, run the following commands:
37+
38+
perl Makefile.PL
39+
make
40+
make test
41+
make install
42+
43+
Yet another alternative way of installing
44+
45+
- Copy lib/Text/PerlPP.pm to a directory in your @INC
46+
- Copy bin/perlpp to a directory in your PATH.
3447

3548
SUPPORT AND DOCUMENTATION
3649

bin/perlpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!perl -w
22
# To run this manually from the source tree, do
33
# perl -Ilib bin/perlpp
4-
use Text::PerlPP;
4+
use strict; use warnings; use Text::PerlPP;
55
exit(Text::PerlPP::Main(\@ARGV));
66
# vi: set ft=perl: #

lib/Text/PerlPP.pm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ sub GetModeOfOB {
144144

145145
sub DQuoteString { # wrap $_[0] in double-quotes, escaped properly
146146
# Not currently used by PerlPP, but provided for use by scripts.
147-
# TODO? inject into the generated script?
147+
# TODO? inject into the generated script?
148148
my $s = shift;
149149

150150
$s =~ s{\\}{\\\\}g;

0 commit comments

Comments
 (0)