Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a README #25

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Mason

Mason - Powerful, high-performance templating for the web and beyond

## Synopsis

foo.mc:
% my $name = "Mason";
Hello world! Welcome to <% $name %>.

#!/usr/bin/env perl
use Mason;
my $mason = Mason->new(comp_root => '...');
print $mason->run('/foo')->output;

## Installation from CPAN

cpanm Mason

## Installtion from source

git clone https://github.com/jonswar/perl-mason.git
cd perl-mason
cpanm Dist::Zilla # ensure DistZilla is installed
dzil -Ilib authordeps --missing | cpanm --no-skip-satisfied

## Documentation

Introductory documentation is available via

perldoc Mason

Detailed documentation is available in the Mason manual:

perldoc Mason::Manual