From c1321fd42d5ed48d2a439e9985d7c285884505db Mon Sep 17 00:00:00 2001 From: Paul Cochrane Date: Mon, 7 Sep 2015 11:34:41 +0200 Subject: [PATCH] Add a README This gives users viewing the initial GitHub page some quick information about the project, how one can install it and where the documentation is. --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..b79cb4e5 --- /dev/null +++ b/README.md @@ -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