Skip to content

Commit f8b73d6

Browse files
authored
Revise README for better clarity and organization
Updated README to improve clarity and structure.
1 parent e062343 commit f8b73d6

1 file changed

Lines changed: 18 additions & 14 deletions

File tree

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,33 @@
1-
# phpBB 3.1 Extension - Acme Demo
1+
# Acme Demo – A phpBB Extension
22

3-
## Installation
3+
A minimal boilerplate extension for **phpBB**, designed to help you quickly get started with extension development. Use it as a foundation and customise it to fit your needs.
44

5-
Clone into phpBB/ext/acme/demo:
5+
---
66

7-
git clone https://github.com/phpbb/phpbb-ext-acme-demo.git phpBB/ext/acme/demo
7+
## Getting Started
88

9-
Go to "ACP" > "Customise" > "Extensions" and enable the "Acme Demo Extension" extension.
9+
If you're new to phpBB extension development, these resources are a great place to begin:
1010

11-
## Tests and Continuous Integration
11+
- [phpBB Extension Development Guide](https://area51.phpbb.com/docs/dev/3.3.x/extensions/index.html)
12+
Comprehensive documentation covering everything you need to know.
1213

13-
We use GitHub Actions and PHPUnit for our unit testing. See more information on the [phpBB development wiki](https://wiki.phpbb.com/Unit_Tests).
14+
- [phpBB Skeleton Extension](https://area51.phpbb.com/docs/dev/3.3.x/extensions/skeleton_extension.html)
15+
A boilerplate generator used to create this demo extension.
1416

15-
[![Tests](https://github.com/phpbb/phpbb-ext-acme-demo/actions/workflows/tests.yml/badge.svg)](https://github.com/phpbb/phpbb-ext-acme-demo/actions/workflows/tests.yml)
17+
---
1618

17-
To run the tests locally, you need to install phpBB from its Git repository. Afterwards run the following command from the phpBB Git repository's root:
19+
## Testing & Continuous Integration
1820

19-
Windows:
21+
This project uses **GitHub Actions** and **PHPUnit** for automated testing.
2022

21-
phpBB\vendor\bin\phpunit.bat -c phpBB\ext\acme\demo\phpunit.xml.dist
23+
![Tests](https://github.com/phpbb/phpbb-ext-acme-demo/actions/workflows/tests.yml/badge.svg)
2224

23-
others:
25+
Learn more about testing phpBB extensions here:
2426

25-
phpBB/vendor/bin/phpunit -c phpBB/ext/acme/demo/phpunit.xml.dist
27+
- [phpBB Extension Testing Tutorial](https://area51.phpbb.com/docs/dev/3.3.x/extensions/tutorial_testing.html)
28+
29+
---
2630

2731
## License
2832

29-
[GPLv2](license.txt)
33+
This project is licensed under the [GNU General Public License v2](license.txt).

0 commit comments

Comments
 (0)