Adds Carton instructions to README.

metacpan · Jan 29, 2014 · ece0e6b · ece0e6b
1 parent 0875a09
commit ece0e6b
Showing 1 changed file with 19 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -20,9 +20,21 @@ Start server on port 5001 (which you want to make authentication work)
 
     $ plackup -p 5001 -r
 
-The backend defaults to C<api.metacpan.org>. Running a local API server is optional and not required to hack on the front-end.
-The address to the API user can be changed in the metacpan_web.conf file.
-Ideally you would create a new file called C<metacpan_web_local.conf> that contains
+## Installing manually via carton
+
+If you prefer to use carton to manage your dependencies, then the above
+commands can be converted to:
+
+    $ carton install
+    $ carton exec prove -lr t/
+    $ carton exec plackup -p 5001 -r
+
+## Local configuration changes
+
+The backend defaults to C<api.metacpan.org>. Running a local API server is
+optional and not required to hack on the front-end.  The address to the API
+user can be changed in the metacpan_web.conf file.  Ideally you would create a
+new file called C<metacpan_web_local.conf> that contains
 
     api        http://127.0.0.1:5000
     api_secure http://127.0.0.1:5000
@@ -32,4 +44,7 @@ which will be loaded on top of the existing config file.
 
 ## COMPATIBILITY NOTES
 
-On Win32 (and possibly also on other platforms) when using Perl < 5.12, the server started with plackup will generate warnings relating to date parsing. These are caused by Plack due to a bug in the gmtime implementation and can be removed by upgrading to Perl 5.12.
+On Win32 (and possibly also on other platforms) when using Perl < 5.12, the
+server started with plackup will generate warnings relating to date parsing.
+These are caused by Plack due to a bug in the gmtime implementation and can be
+removed by upgrading to Perl 5.12.