Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
miyagawa committed Jun 26, 2011
1 parent 5a31e69 commit 2b78ae1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 15 deletions.
18 changes: 11 additions & 7 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ NAME
Carton - Perl module dependency manager (aka Bundler for Perl)

SYNOPSIS
# During the development
# On your development environment
> cat Makefile.PL
use inc::Module::Install;
name 'MyApp';
Expand All @@ -12,12 +12,13 @@ SYNOPSIS
requires 'Starman', 0.2000;

WriteAll;

> carton install
> git commit -m "add Plack and Starman" Makefile.PL carton.lock
> git add Makefile.PL carton.lock
> git commit -m "add Plack and Starman"

# Then elsewhere (on a deployment machine)
> carton install --deployment
# Other developer's machine, or on a deployment box
> carton install
> carton exec starman -p 8080 myapp.psgi

WARNING
Expand Down Expand Up @@ -62,9 +63,12 @@ TUTORIAL
*carton.lock* in your directory.

Make sure you add *carton.lock* to your version controlled repository
and commit changes as you update dependencies.
and commit changes as you update dependencies. This will ensure that
other developers on your app, as well as your deployment environment,
use exactly the same versions of the modules you just installed.

> git commit -m "Added Plack and Starman" Makefile.PL carton.lock
> git add Makefile.PL carton.lock
> git commit -m "Added Plack and Starman"

You can aternatively install modules adhoc from the command line,
without managing the build file at all.
Expand Down
20 changes: 12 additions & 8 deletions lib/Carton.pod
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Carton - Perl module dependency manager (aka Bundler for Perl)

=head1 SYNOPSIS

# During the development
# On your development environment
> cat Makefile.PL
use inc::Module::Install;
name 'MyApp';
Expand All @@ -14,12 +14,13 @@ Carton - Perl module dependency manager (aka Bundler for Perl)
requires 'Starman', 0.2000;

WriteAll;

> carton install
> git commit -m "add Plack and Starman" Makefile.PL carton.lock
> git add Makefile.PL carton.lock
> git commit -m "add Plack and Starman"

# Then elsewhere (on a deployment machine)
> carton install --deployment
# Other developer's machine, or on a deployment box
> carton install
> carton exec starman -p 8080 myapp.psgi

=head1 WARNING
Expand Down Expand Up @@ -68,10 +69,13 @@ The modules are installed into your I<local> directory, and the
dependencies tree and version information are analyzed and saved into
I<carton.lock> in your directory.

Make sure you add I<carton.lock> to your version controlled
repository and commit changes as you update dependencies.
Make sure you add I<carton.lock> to your version controlled repository
and commit changes as you update dependencies. This will ensure that
other developers on your app, as well as your deployment environment,
use exactly the same versions of the modules you just installed.

> git commit -m "Added Plack and Starman" Makefile.PL carton.lock
> git add Makefile.PL carton.lock
> git commit -m "Added Plack and Starman"

You can aternatively install modules adhoc from the command line,
without managing the build file at all.
Expand Down

0 comments on commit 2b78ae1

Please sign in to comment.