Skip to content

Commit bd54dd8

Browse files
committed
Update generated readme with Full Docs
1 parent 174e0ef commit bd54dd8

File tree

1 file changed

+9
-20
lines changed

1 file changed

+9
-20
lines changed

skeleton/README.md.twig

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,18 @@
11
# {{ EXTENSION.extension_display_name }}
22

3-
## Installation
4-
5-
Copy the extension to phpBB/ext/{{ EXTENSION.vendor_name }}/{{ EXTENSION.extension_name }}
6-
7-
Go to "ACP" > "Customise" > "Extensions" and enable the "{{ EXTENSION.extension_display_name }}" extension.
8-
9-
{% if COMPONENT.tests %}
10-
## Tests and Continuous Integration
3+
This is a basic skeleton to help you start building a phpBB extension. Customise it as needed.
114

12-
{% if COMPONENT.githubactions %}We use GitHub Actions as a continuous integration server and phpunit for our unit testing..{% endif %}
13-
To run the tests locally, you need to install phpBB from its Git repository. Afterward run the following command from the phpBB Git repository's root:
14-
15-
Windows:
16-
17-
phpBB\vendor\bin\phpunit.bat -c phpBB\ext\{{ EXTENSION.vendor_name }}\{{ EXTENSION.extension_name }}\phpunit.xml.dist
18-
19-
others:
5+
## Installation
206

21-
phpBB/vendor/bin/phpunit -c phpBB/ext/{{ EXTENSION.vendor_name }}/{{ EXTENSION.extension_name }}/phpunit.xml.dist
7+
1. Copy the extension to: `phpBB/ext/{{ EXTENSION.vendor_name }}/{{ EXTENSION.extension_name }}`
8+
2. In the ACP, go to: **Customise → Extensions**
9+
3. Enable the **{{ EXTENSION.extension_display_name }}** extension
2210

11+
## Extension Development Guide
2312

24-
See more information on the [phpBB Developer Docs](https://area51.phpbb.com/docs/dev/master/testing/index.html)
13+
New to phpBB extension development?
14+
Start here: [phpBB Extension Development Guide](https://area51.phpbb.com/docs/dev/3.3.x/extensions/index.html)
2515

26-
{% endif %}
2716
## License
2817

29-
[GNU General Public License v2](license.txt)
18+
Licensed under the [GNU General Public License v2](license.txt)

0 commit comments

Comments
 (0)