documentation/manual/en/module_specs/Zend_Tool_Project-CreateProject.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.tool.project.create-a-project">
   4     <title>Create A Project</title>
   5
   6     <note>
   7         <para>
   8             The following examples will assume you have the command line interface of
   9             <classname>Zend_Tool_Framework</classname> available to you.
  10         </para>
  11     </note>
  12
  13     <note>
  14         <para>
  15             To issue any of the commands for <classname>Zend_Tool_Project</classname> with
  16             <acronym>CLI</acronym>, you must be in the directory where the project was
  17             initially created.
  18         </para>
  19     </note>
  20
  21     <para>
  22         To get started with <classname>Zend_Tool_Project</classname>, you simply need to create a
  23         project. Creating a project is simple: go to a place on your filesystem, create a directory,
  24         change to that directory, then issue the following command:
  25     </para>
  26
  27     <para>
  28         <command>/tmp/project$ zf create project</command>
  29     </para>
  30
  31     <para>
  32         Optionally, you can create a directory anywhere by the following:
  33     </para>
  34
  35     <para>
  36         <command>$ zf create project /path/to/non-existent-dir</command>
  37     </para>
  38
  39     <para>
  40         The following table will describe the capabilities of providers that are available to
  41         you. As you can see in this table, there is a "Project" provider. The Project provider
  42         has a couple of actions associated to it, and with those actions a number of options that
  43         can be used to modify the behavior of the action and provider.
  44     </para>
  45
  46     <table id="zend.tool.project.project-provider-table">
  47         <title>Project Provider Options</title>
  48
  49         <tgroup cols="4">
  50             <thead>
  51                 <row>
  52                     <entry>Provider Name</entry>
  53                     <entry>Available Actions</entry>
  54                     <entry>Parameters</entry>
  55                     <entry><acronym>CLI</acronym> Usage</entry>
  56                 </row>
  57             </thead>
  58
  59             <tbody>
  60                 <row>
  61                     <entry>Project</entry>
  62                     <entry>Create / Show</entry>
  63                     <entry>create - [path=null, profile='default']</entry>
  64                     <entry><command>zf create project some/path</command></entry>
  65                 </row>
  66             </tbody>
  67         </tgroup>
  68     </table>
  69 </sect1>