@@ -202,7 +202,10 @@ you to use the following standardized instructions in your ``README`` file.
202
202
203
203
.. sidebar :: Installation Instructions Template
204
204
205
- .. raw :: rst
205
+ This template assumes that your bundle is in its ``1.x `` version. If not,
206
+ change the ``"~1" `` installation version accordingly (e.g. ``"~2" ``).
207
+
208
+ .. raw :: md
206
209
207
210
Installation
208
211
============
@@ -212,36 +215,36 @@ you to use the following standardized instructions in your ``README`` file.
212
215
213
216
Use Composer to add the bundle as a new dependency of your project:
214
217
215
- .. code-block:: bash
216
-
217
- $ composer require "<vendor>/<bundle-name>:dev-master"
218
+ ```
219
+ $ composer require <package-name> "~1"
220
+ ```
218
221
219
222
This command requires to have installed Composer globally, as explained
220
- ` in the installation chapter < https://getcomposer.org/doc/00-intro.md>`_
223
+ in the [ installation chapter]( https://getcomposer.org/doc/00-intro.md)
221
224
of Composer documentation.
222
225
223
226
Step 2: Enable the Bundle
224
227
-------------------------
225
228
226
- Then, enable the bundle adding the following line in the `` AppKernel` `
229
+ Then, enable the bundle adding the following line in the `AppKernel`
227
230
class of your project:
228
231
229
- .. code-block:: php
230
-
231
- <?php
232
- // app/AppKernel.php
232
+ ```php
233
+ <?php
234
+ // app/AppKernel.php
233
235
234
- public function registerBundles()
235
- {
236
- $bundles = array(
237
- // ...
236
+ public function registerBundles()
237
+ {
238
+ $bundles = array(
239
+ // ...
238
240
239
- new <vendor>\<bundle-name>\<bundle-long-name>(),
240
- );
241
- }
241
+ new <vendor>\<bundle-name>\<bundle-long-name>(),
242
+ );
243
+ }
244
+ ```
242
245
243
- (optionally add *Step 3*, *Step 4*, etc. to explain other required
244
- installation steps, such as registering routes or dumping assets)
246
+ Optionally you can add *Step 3 *, *Step 4 *, etc. to explain other required
247
+ installation steps, such as registering routes or dumping assets.
245
248
246
249
247
250
Routing
0 commit comments