README.md

   1 ZendSkeletonApplication
   2 =======================
   3
   4 Introduction
   5 ------------
   6 This is a simple, skeleton application using the ZF2 MVC layer and module
   7 systems. This application is meant to be used as a starting place for those
   8 looking to get their feet wet with ZF2.
   9
  10
  11 Installation
  12 ------------
  13 The easiest way to get a working copy of this project is to do a recursive
  14 clone:
  15
  16     git clone --recursive git://github.com/zendframework/ZendSkeletonApplication.git
  17
  18 After the clone is complete, set up a virtual host to point to the public/
  19 directory of the project and you should be ready to go!
  20
  21 If you're wondering what the `--recursive` flag is, keep reading:
  22
  23 Git Submodules
  24 --------------
  25 This project makes use of [Git submodules](http://book.git-scm.com/5_submodules.html).
  26 Utilizing Git submodules allows us to reference an exact commit in the upstream
  27 [zendframework/zf2](https://github.com/zendframework/zf2) repository and ensure
  28 that those who have cloned the project have that same commit checked out. This
  29 provides several benefits:
  30
  31 * Developers do not have to worry about which commit of the zf2 project to have
  32   checked out for this project to work.
  33 * No additional steps to "install" Zend Framework are needed; it "just works"
  34   after a cloning the project.
  35
  36 There are a couple of mild caveats to be aware of:
  37 * Be sure to always run `git submodule update` after pulling, as merge/rebase
  38   does not automatically update the checked out commit in submodules if it has
  39   been changed.
  40 * The initial clone will be a bit slower, due to it having to pull down a
  41   separate copy of ZF2 from what you already have.