Skip to content

Commit 7711e41

Browse files
committed
Updated Readme
1 parent 02fb465 commit 7711e41

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,40 @@
55
Is a simple module skeleton to illustrate the module interface of HumHub.
66

77
Alternatively you can use a module generator for HumHub in the [DevTools module](https://github.com/humhub-contrib/devtools).
8+
9+
## Use Boilerplate
10+
11+
1.) Checkout module
12+
13+
Clone the module and then delete the Git files. This is necessary to move the module to a new Git repository later.
14+
15+
```
16+
cd my-new-project
17+
git clone https://github.com/humhub/humhub-modules-example-basic.git .
18+
rm .git -rf
19+
```
20+
21+
22+
2.) Modify the file `docs/rewrite-module-id.php` and set the variables `$newModuleId` and `$newNamespace`.
23+
24+
** Example: **
25+
26+
```php
27+
// docs/rewrite-module-id.php
28+
29+
// ...
30+
31+
$newModuleId = "formbuilder";
32+
$newNamespace = 'coolSoft\humhub\modules\formbuilder';
33+
34+
// ...
35+
```
36+
37+
3.) Run the `docs/rewrite-id.php` from shell.
38+
39+
```
40+
cd docs/
41+
php rewrite-module-id.php
42+
```
43+
44+
4.) Run the `docs/rewrite-id.php` from shell.

0 commit comments

Comments
 (0)