[catagits/Catalyst-Runtime.git] / README.pod

=head1 Welcome to Catalyst

This is the Runtime distribution for the L<Catalyst MVC framework|http://www.catalystframework.org/>.

For more information about Catalyst, write

    perldoc Catalyst

at the command line, or visit http://www.catalystframework.org/.

=head2 Getting Started

1. Install Catalyst if you haven't yet:

    cpanm Catalyst

2. Create a new catalyst application:

    catalyst.pl DemoApp

3. Change the directory to the newly created directory and start the built-in developer server

    cd DemoApp; plackup -Ilib demoapp.psgi

4. Go to http://localhost:5000 and you'll see the default welcome page.

=head2 Resources

You can also install L<Catalyst::Manual|https://metacpan.org/module/Catalyst::Manual> 
from CPAN for more comprehensive information.

If you are going to write your own Catalyst application, you will need to
install L<Catalyst::Devel|https://metacpan.org/module/Catalyst::Devel>.
Afterwards run I<catalyst.pl> for more information about creating your first
app.

=head2 Contributing

If you would like to contribute to Catalyst, please 
L<join us|http://chat.mibbit.com/#catalyst@irc.perl.org> on IRC,
or visit the L<mailing list|http://lists.scsys.co.uk/mailman/listinfo/catalyst>.
Commit	Line	Data
52e012fb	1	=head1 Welcome to Catalyst
	2
	3	This is the Runtime distribution for the L<Catalyst MVC framework\|http://www.catalystframework.org/>.
	4
	5	For more information about Catalyst, write
	6
	7	perldoc Catalyst
	8
	9	at the command line, or visit http://www.catalystframework.org/.
	10
	11	=head2 Getting Started
	12
	13	1. Install Catalyst if you haven't yet:
	14
	15	cpanm Catalyst
	16
	17	2. Create a new catalyst application:
	18
	19	catalyst.pl DemoApp
	20
	21	3. Change the directory to the newly created directory and start the built-in developer server
	22
	23	cd DemoApp; plackup -Ilib demoapp.psgi
	24
	25	4. Go to http://localhost:5000 and you'll see the default welcome page.
	26
	27	=head2 Resources
	28
	29	You can also install L<Catalyst::Manual\|https://metacpan.org/module/Catalyst::Manual>
	30	from CPAN for more comprehensive information.
	31
	32	If you are going to write your own Catalyst application, you will need to
	33	install L<Catalyst::Devel\|https://metacpan.org/module/Catalyst::Devel>.
	34	Afterwards run I<catalyst.pl> for more information about creating your first
	35	app.
	36
	37	=head2 Contributing
	38
	39	If you would like to contribute to Catalyst, please
	40	L<join us\|http://chat.mibbit.com/#catalyst@irc.perl.org> on IRC,
64111aca	41	or visit the L<mailing list\|http://lists.scsys.co.uk/mailman/listinfo/catalyst>.