X-Git-Url: http://git.inspyration.org/?a=blobdiff_plain;f=README.md;h=dd9072bc9233a1584ac63d49a9dc9d87e42686fb;hb=d5f0f3216084687f5224e2b4c2768fefca628500;hp=849078f71a870e47f82ed640f563e2d03f71fc9b;hpb=96c5e83e41ccdf6d1b4a712bbf4e4f380a2a6a42;p=zf2.biz%2Fgalerie.git

diff --git a/README.md b/README.md
index 849078f..dd9072b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,60 @@
-Sample, skeleton application using the ZF2 MVC layer.
+ZendSkeletonApplication
+=======================
+
+Introduction
+------------
+This is a simple, skeleton application using the ZF2 MVC layer and module
+systems. This application is meant to be used as a starting place for those
+looking to get their feet wet with ZF2.
+
+
+Installation
+------------
+
+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!