X-Git-Url: http://git.inspyration.org/?a=blobdiff_plain;f=README.md;h=dd9072bc9233a1584ac63d49a9dc9d87e42686fb;hb=d5f0f3216084687f5224e2b4c2768fefca628500;hp=40993e2248db4a9dafbd2570ab05be92ba5b2969;hpb=5209e9a7c0cfc2663c0316327e678f1c9d5d0387;p=zf2.biz%2Fgalerie.git diff --git a/README.md b/README.md index 40993e2..dd9072b 100644 --- a/README.md +++ b/README.md @@ -10,32 +10,51 @@ looking to get their feet wet with ZF2. Installation ------------ -The easiest way to get a working copy of this project is to do a recursive -clone: - - git clone --recursive git://github.com/zendframework/ZendSkeletonApplication.git - -After the clone is complete, set up a virtual host to point to the public/ -directory of the project and you should be ready to go! - -If you're wondering what the `--recursive` flag is, keep reading: - -Git Submodules --------------- -This project makes use of [Git submodules](http://book.git-scm.com/5_submodules.html). -Utilizing Git submodules allows us to reference an exact commit in the upstream -[zendframework/zf2](https://github.com/zendframework/zf2) repository and ensure -that those who have cloned the project have that same commit checked out. This -provides several benefits: - -* Developers do not have to worry about which commit of the zf2 project to have - checked out for this project to work. -* No additional steps to "install" Zend Framework are needed; it "just works" - after a cloning the project. - -There are a couple of mild caveats to be aware of: -* Be sure to always run `git submodule update` after pulling, as merge/rebase - does not automatically update the checked out commit in submodules if it has - been changed. -* The initial clone will be a bit slower, due to it having to pull down a - separate copy of ZF2 from what you already have. + +Using Composer (recommended) +---------------------------- +The recommended way to get a working copy of this project is to clone the repository +and use composer to install dependencies: + + cd my/project/dir + git clone git://github.com/zendframework/ZendSkeletonApplication.git + cd ZendSkeletonApplication + php composer.phar install + +Using Git submodules +-------------------- +Alternatively, you can install using native git submodules. This method works fine but it is +recommended that you use Composer due to the dependency management it provides. + + git clone git://github.com/zendframework/ZendSkeletonApplication.git --recursive + +You will also need to update public/index.php and modules/Application/Module.php to enable autoloading. +For public/index.php, replace lines 2-13 with: + + use Zend\Loader\AutoloaderFactory, + Zend\ServiceManager\ServiceManager, + Zend\Mvc\Service\ServiceManagerConfiguration; + + chdir(dirname(__DIR__)); + require_once (getenv('ZF2_PATH') ?: 'vendor/ZendFramework/library') . '/Zend/Loader/AutoloaderFactory.php'; + + // Setup autoloader + AutoloaderFactory::factory(); + +Within modules/Application/Module.php add this method to the Application class: + + public function getAutoloaderConfig() + { + return array( + 'Zend\Loader\StandardAutoloader' => array( + 'namespaces' => array( + __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__, + ), + ), + ); + } + +Virtual Host +------------ +Afterwards, set up a virtual host to point to the public/ directory of the +project and you should be ready to go!