|
@@ -16,9 +16,24 @@ include:
|
|
|
|
|
|
Installation
|
|
|
------------
|
|
|
-Checkout a copy of the code::
|
|
|
+First you must checkout a copy of the code. There are two common ways to do this.
|
|
|
|
|
|
- git submodule add https://github.com/schmittjoh/JMSSerializerBundle.git src/JMS/SerializerBundle
|
|
|
+**Using Deps File**
|
|
|
+
|
|
|
+Add the following to the ``deps`` file of your Symfony Standard Distribution::
|
|
|
+
|
|
|
+ [JMSSerializerBundle]
|
|
|
+ git=git://github.com/schmittjoh/JMSSerializerBundle.git
|
|
|
+ target=bundles/JMS/SerializerBundle
|
|
|
+
|
|
|
+**Using Git Submodules**
|
|
|
+
|
|
|
+If you prefer to use git submodules use the following command::
|
|
|
+
|
|
|
+ git submodule add https://github.com/schmittjoh/JMSSerializerBundle.git vendor/bundles/JMS/SerializerBundle
|
|
|
+
|
|
|
+
|
|
|
+**Register The Bundle**
|
|
|
|
|
|
Then register the bundle with your kernel::
|
|
|
|
|
@@ -29,11 +44,31 @@ Then register the bundle with your kernel::
|
|
|
// ...
|
|
|
);
|
|
|
|
|
|
+**Get the Metadata Library**
|
|
|
+
|
|
|
This bundle also requires the Metadata library (**you need the 1.1 version, not the 1.0
|
|
|
-version** which ships with the Symfony Standard Edition)::
|
|
|
+version** which ships with the Symfony Standard Edition.)
|
|
|
+
|
|
|
+**Using Deps File**
|
|
|
+
|
|
|
+Update the ``metadata`` of your ``deps`` file::
|
|
|
+
|
|
|
+ [metadata]
|
|
|
+ git=http://github.com/schmittjoh/metadata.git
|
|
|
+ version=1.1.0
|
|
|
+
|
|
|
+Now use the ``vendors`` script to clone the newly added repositories into your project::
|
|
|
+
|
|
|
+ php bin/vendors install --reinstall
|
|
|
+
|
|
|
+**Using Git Submodules**
|
|
|
+
|
|
|
+If you are using submodules use the following command::
|
|
|
|
|
|
git submodule add https://github.com/schmittjoh/metadata.git vendor/metadata
|
|
|
|
|
|
+**Register Metadata with the autoloader**
|
|
|
+
|
|
|
Make sure that you also register the namespaces with the autoloader::
|
|
|
|
|
|
// app/autoload.php
|
|
@@ -499,3 +534,4 @@ YAML Reference
|
|
|
post_deserialize: [foo, bar]
|
|
|
|
|
|
|
|
|
+
|