X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=README.mkdn;h=ad3aa2d90377af7dd0a433ae19137fd103679dda;hp=f30025cae2efee41b0a6962a850e3e03a809d512;hb=1d00b2ffb8806bd0a8190ee8580a85895e48f8e4;hpb=9e7f288e0bd785c69c8e54c77d951b2e878f5b8f diff --git a/README.mkdn b/README.mkdn index f30025c..ad3aa2d 100644 --- a/README.mkdn +++ b/README.mkdn @@ -14,6 +14,11 @@ Catalyst - The Elegant MVC Web Application Framework See the [Catalyst::Manual](https://metacpan.org/pod/Catalyst::Manual) distribution for comprehensive documentation and tutorials. + # Building Catalyst for development + cpanm --local-lib=~/perl5 local::lib && eval $(perl -I ~/perl5/lib/perl5/ -Mlocal::lib) + cpanm --installdeps --with-develop . + perl Makefile.PL + # Install Catalyst::Devel for helpers and other development tools # use the helper to create a new application catalyst.pl MyApp @@ -1440,7 +1445,7 @@ variable should be used for determining the request path. decoded, this means that applications using this mode can correctly handle URIs including the %2F character (i.e. with `AllowEncodedSlashes` set to `On` in Apache). - Given that this method of path resolution is provably more correct, it is recommended that you use + Given that this method of path resolution is probably more correct, it is recommended that you use this unless you have a specific need to deploy your application in a non-standard environment, and you are aware of the implications of not being able to handle encoded URI paths correctly. @@ -1454,7 +1459,7 @@ variable should be used for determining the request path. - `using_frontend_proxy_path` - Enabled [Plack::Middleware::ReverseProxyPath](https://metacpan.org/pod/Plack::Middleware::ReverseProxyPath) on your application (if installed, otherwise log an error). This is useful if your application is not running on the 'root' (or /) of your host server. **NOTE** if you use this feature you should add the required -middleware to your project dependency list since its not automatically a dependency of [Catalyst](https://metacpan.org/pod/Catalyst). +middleware to your project dependency list since it's not automatically a dependency of [Catalyst](https://metacpan.org/pod/Catalyst). This has been done since not all people need this feature and we wish to restrict the growth of [Catalyst](https://metacpan.org/pod/Catalyst) dependencies. - `encoding` - See ["ENCODING"](#encoding) @@ -1497,7 +1502,7 @@ This has been done since not all people need this feature and we wish to restric - `skip_complex_post_part_handling` - When creating body parameters from a POST, if we run into a multpart POST + When creating body parameters from a POST, if we run into a multipart POST that does not contain uploads, but instead contains inlined complex data (very uncommon) we cannot reliably convert that into field => value pairs. So instead we create an instance of [Catalyst::Request::PartData](https://metacpan.org/pod/Catalyst::Request::PartData). If this causes @@ -1515,9 +1520,9 @@ This has been done since not all people need this feature and we wish to restric - `do_not_decode_query` If true, then do not try to character decode any wide characters in your - request URL query or keywords. Most readings of the relevent specifications + request URL query or keywords. Most readings of the relevant specifications suggest these should be UTF-\* encoded, which is the default that [Catalyst](https://metacpan.org/pod/Catalyst) - will use, hwoever if you are creating a lot of URLs manually or have external + will use, however if you are creating a lot of URLs manually or have external evil clients, this might cause you trouble. If you find the changes introduced in Catalyst version 5.90080+ break some of your query code, you may disable the UTF-8 decoding globally using this configuration. @@ -1528,7 +1533,7 @@ This has been done since not all people need this feature and we wish to restric - `default_query_encoding` By default we decode query and keywords in your request URL using UTF-8, which - is our reading of the relevent specifications. This setting allows one to + is our reading of the relevant specifications. This setting allows one to specify a fixed value for how to decode your query. You might need this if you are doing a lot of custom encoding of your URLs and not using UTF-8. @@ -1553,15 +1558,15 @@ This has been done since not all people need this feature and we wish to restric - `data_handlers` - See ["DATA HANDLERS"](#data-handlers). - `stats_class_traits` - An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get componsed into your stats class. + An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get composed into your stats class. - `request_class_traits` - An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get componsed into your request class. + An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get composed into your request class. - `response_class_traits` - An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get componsed into your response class. + An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get composed into your response class. - `inject_components` @@ -2009,7 +2014,7 @@ acme: Leon Brocard abraxxa: Alexander Hartmaier -andrewalker: André Walker +andrewalker: André Walker Andrew Bramble @@ -2067,7 +2072,7 @@ groditi: Guillermo Roditi hobbs: Andrew Rodland -ilmari: Dagfinn Ilmari Mannsåker +ilmari: Dagfinn Ilmari MannsÃ¥ker jcamacho: Juan Camacho @@ -2089,6 +2094,8 @@ konobi: Scott McWhirter marcus: Marcus Ramberg +Mischa Spiegelmock + miyagawa: Tatsuhiko Miyagawa mgrimes: Mark Grimes