User Tools

Site Tools


how_to_pack_your_add-on

How To Pack Your Add-on

When distributing your add-ons it's important that users recognize the way they are installing the add-ons. Therefore we have created a guideline how to pack your add-ons.

Create A Zip-Archive

A .zip archive should contain the following:

File/Folder Description
public_html/ Directory of files to upload
CREDITS.md (optional) A plain text file with credits to any other authors of scripts, graphics, etc.
LICENSE.md (optional) A plain text file with a license statement
README.md A plain text file with instructions how to install the add-on
UPGRADE.md (optional) A plain text file with instructions how to upgrade from a previous version

Here is a README-file example you may use.

how_to_pack_your_add-on.txt · Last modified: 2015/10/06 09:51 by 78.72.180.122