Skip to content

Commit 8752a59

Browse files
committedMay 9, 2024·
update readme
1 parent dd788e3 commit 8752a59

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed
 

‎README.md

+33
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,39 @@
33
A moodle local plugin that manages the subplugins for the moodle townsquare block.
44
Documentation of the townsquare block: https://github.com/learnweb/moodle-local_townsquare
55

6+
## How to install a subplugin ##
7+
8+
To install a townsquare subplugin, clone the repository of the subplugin into the
9+
10+
`{your/moodle/dirroot}/local/townsquaresupport/townsquareexpansion/{pluginname}
11+
`
12+
13+
directory.
14+
15+
Afterwards, log in to your Moodle site as an admin and go to _Site administration >
16+
Notifications_ to complete the installation.
17+
18+
Alternatively, you can run
19+
20+
$ php admin/cli/upgrade.php
21+
22+
to complete the installation from the command line.
23+
24+
## How to implement a subplugin ##
25+
26+
To implement a subplugin for townsquare, the subplugins needs to meet the following requirements:
27+
28+
1. The plugin type must be`townsquareexpansion_{pluginname}`.
29+
2. The plugins must have at least the following files:
30+
31+
- `version.php`
32+
- `lang/en/{pluginname}.php `
33+
- `classes/{pluginname}.php `
34+
35+
The most important file is the `{pluginname}` class. This class needs to implement the `townsquaresupportinterface` located in
36+
`{your/moodle/dirroot}/local/townsquaresupport/classes/townsquaresupportinterface.php.`. By implementing the interface, the
37+
subplugin can make notifications available for the townsquare block.
38+
639
## Installing via uploaded ZIP file ##
740

841
1. Log in to your Moodle site as an admin and go to _Site administration >

0 commit comments

Comments
 (0)
Please sign in to comment.