From e802b98897a1c4fb5b1c4e12ca319a01e7d3d841 Mon Sep 17 00:00:00 2001 From: Igor Wiedler Date: Fri, 13 Apr 2012 12:36:27 +0200 Subject: [PATCH] [improve-docs] Move create-project command documentation into cli chapter --- doc/03-cli.md | 28 ++++++++++++++++++++++++++++ doc/articles/create-projects.md | 23 ----------------------- 2 files changed, 28 insertions(+), 23 deletions(-) delete mode 100644 doc/articles/create-projects.md diff --git a/doc/03-cli.md b/doc/03-cli.md index 45344adea..d973783e1 100644 --- a/doc/03-cli.md +++ b/doc/03-cli.md @@ -142,6 +142,34 @@ command. It will replace your `composer.phar` with the latest version. $ php composer.phar self-update +## create-project + +You can use Composer to create new projects from an existing package. +There are several applications for this: + +1. You can deploy application packages. +2. You can check out any package and start developing on patches for example. +3. Projects with multiple developers can use this feature to bootstrap the + initial application for development. + +To create a new project using composer you can use the "create-project" command. +Pass it a package name, and the directory to create the project in. You can also +provide a version as third argument, otherwise the latest version is used. + +The directory is not allowed to exist, it will be created during installation. + + php composer.phar create-project doctrine/orm path 2.2.0 + +By default the command checks for the packages on packagist.org. + +### Options + +* **--repository-url:** Provide a custom repository to search for the package, + which will be used instead of packagist. Can be either an HTTP URL pointing + to a `composer` repository, or a path to a local `packages.json` file. +* **--prefer-source:** Get a development version of the code checked out + from version control. + ## help To get more information about a certain command, just use `help`. diff --git a/doc/articles/create-projects.md b/doc/articles/create-projects.md deleted file mode 100644 index 9dda91117..000000000 --- a/doc/articles/create-projects.md +++ /dev/null @@ -1,23 +0,0 @@ -# Create Projects - -You can use Composer to create new projects from an existing package. -There are several applications for this: - -1. You can deploy application packages. -2. You can check out any package and start developing on patches for example. -3. Projects with multiple developers can use this feature to bootstrap the initial application for development. - -To create a new project using composer you can use the "create-project" command. -Pass it a package name, and the directory to create the project in. You can also -provide a version as third argument, otherwise the latest version is used. - -The directory is not allowed to exist, it will be created during installation. - - php composer.phar create-project doctrine/orm path 2.2.0 - -By default the command checks for the packages on packagist.org. To change this behavior -you can use the --repository-url parameter and either point it to an HTTP url -for your own packagist repository or to a packages.json file. - -If you want to get a development version of the code directly checked out -from version control you have to add the --prefer-source parameter.