matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document reuse.

Browse Source
This commit is contained in:
John Livingston
2024-05-23 12:28:23 +02:00
parent 0708ca00cf
commit a870ba6488
37 changed files with 7496 additions and 9906 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
support/documentation/content/en/contributing/develop/_index.md
View File

@ -37,6 +37,7 @@ To build the plugin, you must have following packages:
* `build-essential`
* `coreutils`
* `wget`
* `reuse`
Please note that this plugin needs an AppImage for the Prosody XMPP server.
This AppImage is provided by the [Prosody AppImage](https://github.com/JohnXLivingston/prosody-appimage) sideproject.
@ -82,6 +83,12 @@ You can build the plugin with extra debug features simply by using:
NODE_ENV=dev npm run build
```
This plugin is [REUSE](https://reuse.software/) compliant: it uses SPDX headers to identify licensing information of its source code.
More information on the [REUSE](https://reuse.software/) website.
You can use the [reuse](https://reuse.readthedocs.io/en/stable/readme.html#) command line tool to help you update headers.
The `npm run lint` command will use the `reuse` command to check compliance.
Don't forget to add your copyright information in SPDX headers when you modify some code.
## ESBuild vs Typescript
This plugin uses ESBuild for frontend code generation, as the official `peertube-plugin-quickstart` plugin.