From 47132b855d4d71c4ea5a798b7d7ef679de2b737e Mon Sep 17 00:00:00 2001 From: Zakariyya Mughal Date: Thu, 9 Nov 2023 13:37:29 -0500 Subject: [PATCH] Add README.md --- README.md | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..caa51b2 --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +# NAME + +Alien::Serd - Find or build Serd RDF processor + +# SYNOPSIS + +From [ExtUtils::MakeMaker](https://metacpan.org/pod/ExtUtils%3A%3AMakeMaker): + + use ExtUtils::MakeMaker; + use Alien::Base::Wrapper (); + + WriteMakefile( + Alien::Base::Wrapper->new('Alien::Serd')->mm_args2( + NAME => 'FOO::XS', + ... + ), + ); + +From [Module::Build](https://metacpan.org/pod/Module%3A%3ABuild): + + use Module::Build; + use Alien::Base::Wrapper qw( Alien::Serd !export ); + use Alien::Serd; + + my $build = Module::Build->new( + ... + configure_requires => { + 'Alien::Base::Wrapper' => '0', + 'Alien::Serd' => '0', + ... + }, + Alien::Base::Wrapper->mb_args, + ... + ); + + $build->create_build_script; + +From [Inline::C](https://metacpan.org/pod/Inline%3A%3AC) / [Inline::CPP](https://metacpan.org/pod/Inline%3A%3ACPP) script: + + use Inline 0.56 with => 'Alien::Serd'; + +From [Dist::Zilla](https://metacpan.org/pod/Dist%3A%3AZilla) + + [@Filter] + -bundle = @Basic + -remove = MakeMaker + + [Prereqs / ConfigureRequires] + Alien::Serd = 0 + + [MakeMaker::Awesome] + header = use Alien::Base::Wrapper qw( Alien::Serd !export ); + WriteMakefile_arg = Alien::Base::Wrapper->mm_args + +From [FFI::Platypus](https://metacpan.org/pod/FFI%3A%3APlatypus): + + use FFI::Platypus; + use Alien::Serd; + + my $ffi = FFI::Platypus->new( + lib => [ Alien::Serd->dynamic_libs ], + ); + +Command line tool: + + use Alien::Serd; + use Env qw( @PATH ); + + unshift @PATH, Alien::Serd->bin_dir; + +# DESCRIPTION + +This distribution provides Serd so that it can be used by other +Perl distributions that are on CPAN. It does this by first trying to +detect an existing install of Serd on your system. If found it +will use that. If it cannot be found, the source code will be downloaded +from the internet and it will be installed in a private share location +for the use of other modules. + +# SEE ALSO + +- [Serd](https://drobilla.net/software/serd.html) + + Serd homepage. + +- [Alien](https://metacpan.org/pod/Alien) + + Documentation on the Alien concept itself. + +- [Alien::Base](https://metacpan.org/pod/Alien%3A%3ABase) + + The base class for this Alien. + +- [Alien::Build::Manual::AlienUser](https://metacpan.org/pod/Alien%3A%3ABuild%3A%3AManual%3A%3AAlienUser) + + Detailed manual for users of Alien classes.