-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Added standard bundle installation instructions #4163
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 10 commits
b297d29
11db860
21ce2c0
ed96447
c39f7d3
322ec60
4b29de2
41ce2a5
7a6644b
35dddba
7097070
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -194,6 +194,59 @@ Extensive documentation should also be provided in the | |
the ``Resources/doc/`` directory; the ``Resources/doc/index.rst`` file is | ||
the only mandatory file and must be the entry point for the documentation. | ||
|
||
Installation Instructions | ||
~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
In order to ease the installation of third-party bundles, consider using the | ||
following standardized instructions in your ``README.md`` file. | ||
|
||
.. code-block:: text | ||
|
||
Installation | ||
============ | ||
|
||
Step 1: Download the Bundle | ||
--------------------------- | ||
|
||
Open a command console, enter your project directory and execute the | ||
following command to download the latest stable version of this bundle: | ||
|
||
```bash | ||
$ composer require <package-name> "~1" | ||
``` | ||
|
||
This command requires to have Composer installed globally, as explained | ||
in the [installation chapter](https://getcomposer.org/doc/00-intro.md) | ||
of Composer documentation. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ... of the Composer documentation. |
||
|
||
Step 2: Enable the Bundle | ||
------------------------- | ||
|
||
Then, enable the bundle adding the following line in the `AppKernel` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ... bundle by adding the following line in the |
||
class of your project: | ||
|
||
```php | ||
<?php | ||
// app/AppKernel.php | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can add a |
||
// ... | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we can remove this blank line. |
||
public function registerBundles() | ||
{ | ||
$bundles = array( | ||
// ... | ||
return new <vendor>\<bundle-name>\<bundle-long-name>(), | ||
); | ||
} | ||
``` | ||
|
||
This template assumes that your bundle is in its ``1.x`` version. If not, change | ||
the ``"~1"`` installation version accordingly (``"~2"``, ``"~3"``, etc.) | ||
|
||
Optionally, you can add more installation steps (*Step 3*, *Step 4*, etc.) to | ||
explain other required installation tasks, such as registering routes or | ||
dumping assets. | ||
|
||
Routing | ||
------- | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... requires you to have Composer