Skip to content

Commit

Permalink
Rework github/README
Browse files Browse the repository at this point in the history
  • Loading branch information
pmqs committed Feb 17, 2024
1 parent d957b1e commit 86f3d12
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 36 deletions.
30 changes: 15 additions & 15 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
[![Linux](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/linux.yml/badge.svg)](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/linux.yml)
[![MacOS](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/macos.yml/badge.svg)](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/macos.yml)
[![Windows](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/windows.yml/badge.svg)](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/windows.yml)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/pmqs/Compress-Raw-Lzma?svg=true)](https://ci.appveyor.com/project/pmqs/Compress-Raw-Lzma)

# Compress-Raw-Lzma
**Upstream Testing**

[![Linux + upstream lzma](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/linux-upstream-gh-xz.yml/badge.svg)](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/linux-upstream-gh-xz.yml)
[![MacOS + upstream lzma](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/macos-upstream-gh-xz.yml/badge.svg)](https://github.com/pmqs/Compress-Raw-Lzma/actions/workflows/macos-upstream-gh-xz.yml)

This module provides a **Perl** interface to allow reading and writing of `lzma`, `lzip`
and `xz` files/buffers.
# Compress::Raw::Lzma - Perl Interface to the Lzma library

For prerequisites and installation instruction, see the **README** file.
This module provides a low-level Perl interface o allow reading and writing of `lzma`, `lzip` and `xz` files/buffers.

For a detailed list of the avilable options see
For details of building and installing this module see the file [README](../README)

Below is a
API Documentation is in [Lzma.pod](Lzma.pod).

This module is also available on [metacpan](https://metacpan.org/) at [Compress::Raw::Lzma](https://metacpan.org/pod/Compress::Raw::Lzma)

General feedback/questions/bug reports should be reported in the [issues](https://github.com/pmqs/Compress-Raw-Lzma/issues) page.

# SUPPORT

General feedback/questions/bug reports should be sent to
https://github.com/pmqs/Compress-Raw-Lzma/issues


# COPYRIGHT

Copyright (c) 2009-2023 Paul Marquess. All rights reserved.
Copyright (c) 2009-2024 Paul Marquess. All rights reserved.

This program is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.


Paul Marquess <pmqs@cpan.org>
Paul Marquess <pmqs@cpan.org>
38 changes: 17 additions & 21 deletions private/MakeUtil.pm
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,17 @@ sub MY::libscan

sub MY::postamble
{
my %params = %{ $_[0] };
my $self = shift ;
my %params = @_ ;

return ''
if $ENV{PERL_CORE} ;
if ($ENV{PERL_CORE} )
{
return <<EOM;
READMEmd:
EOM
}

my @files = getPerlFiles('MANIFEST');

Expand All @@ -68,27 +75,16 @@ MyTrebleCheck:
';

# pod2markdown only supported from Perl 5.8
if (-e '.github' && $] >= 5.008)
if (-e '.github' && exists $params{name})
{
$postamble .= <<EOM;
my $name = $params{name};
$postamble .= <<"EOM";
READMEmd: .github/README.md
READMEmd: .github/$name.pod
.github/README.md: $params{VERSION_FROM} .github/badges
\@echo Creating .github/README.md from $params{VERSION_FROM}
\$(NOECHO) \$(RM_F) .github/README.md
\$(NOECHO) \$(TOUCH) .github/README.md
\$(CHMOD) \$(PERM_RW) .github/badges
\$(NOECHO) \$(CP_NONEMPTY) .github/badges .github/README.md \$(PERM_RW)
\$(NOECHO) pod2markdown $params{VERSION_FROM} >>.github/README.md
EOM
}
else {
$postamble .= <<EOM;
READMEmd:
.github/$name.pod: lib/Compress/Raw/$name.pm
\@echo Creating .github/$name.pod from $name.pm
\$(NOECHO) perl -e 'while(<>){ next if 1 .. /^__END__/; print}' lib/Compress/Raw/$name.pm >.github/Bzip2.pod
EOM
}
Expand Down

0 comments on commit 86f3d12

Please sign in to comment.