@@ -194,6 +194,56 @@ Extensive documentation should also be provided in the
194
194
the ``Resources/doc/ `` directory; the ``Resources/doc/index.rst `` file is
195
195
the only mandatory file and must be the entry point for the documentation.
196
196
197
+ Installation instructions
198
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
199
+
200
+ In order to ease the installation process of third-party bundles, we propose
201
+ you to use the following standardized instructions in your ``README `` file.
202
+
203
+ .. sidebar :: Bundle Instructions Template
204
+
205
+ .. raw :: rst
206
+
207
+ Installation
208
+ ============
209
+
210
+ Step 1: Download the Bundle
211
+ ---------------------------
212
+
213
+ Use Composer to add the bundle as a new dependency of your project:
214
+
215
+ .. code-block:: bash
216
+
217
+ $ composer require "<vendor>/<bundle-name>:dev-master"
218
+
219
+ This command requires to have installed Composer globally, as explained
220
+ `in the installation chapter <https://getcomposer.org/doc/00-intro.md>`_
221
+ of Composer documentation.
222
+
223
+ Step 2: Enable the Bundle
224
+ -------------------------
225
+
226
+ Then, enable the bundle adding the following line in the ``AppKernel``
227
+ class of your project:
228
+
229
+ .. code-block:: php
230
+
231
+ <?php
232
+ // app/AppKernel.php
233
+
234
+ public function registerBundles()
235
+ {
236
+ $bundles = array(
237
+ // ...
238
+
239
+ new <vendor>\<bundle-name>\<bundle-long-name>(),
240
+ );
241
+ }
242
+
243
+ (optionally add *Step 3*, *Step 4*, etc. to explain other required
244
+ installation steps, such as registering routes or dumping assets)
245
+
246
+
197
247
Routing
198
248
-------
199
249
@@ -268,53 +318,6 @@ semantic configuration described in the cookbook.
268
318
If you are defining services, they should also be prefixed with the bundle
269
319
alias.
270
320
271
- Installation instructions
272
- -------------------------
273
-
274
- In order to ease the installation process of third-party bundles, we propose
275
- you to use the following standardized instructions in your ``README `` file:
276
-
277
- .. code-block ::
278
-
279
- Installation
280
- ============
281
-
282
- Step 1: Download the bundle
283
- ---------------------------
284
-
285
- Use Composer to add the bundle as a new dependency of your project:
286
-
287
- .. code-block:: bash
288
-
289
- $ composer require "<vendor>/<bundle-name>:dev-master"
290
-
291
- This command requires to have installed Composer globally, as explained
292
- `in the installation chapter <https://getcomposer.org/doc/00-intro.md>`_
293
- of Composer documentation.
294
-
295
- Step 2: Enable the bundle
296
- -------------------------
297
-
298
- Then, enable the bundle adding the following line in the ``AppKernel`` class
299
- of your project:
300
-
301
- .. code-block:: php
302
-
303
- <?php
304
- // app/AppKernel.php
305
-
306
- public function registerBundles()
307
- {
308
- $bundles = array(
309
- // ...
310
-
311
- new <vendor>\<bundle-name>\<bundle-long-name>(),
312
- );
313
- }
314
-
315
- (optionally add *Step 3*, *Step 4*, etc. to explain other required
316
- installation steps, such as registering routes or dumping assets)
317
-
318
321
Learn more from the Cookbook
319
322
----------------------------
320
323
0 commit comments