IMPORTANT NOTICE
During the next period of time, the Thecus Wiki will migrate to a new site - the NAS Website. The migration is part of an improvement initiative, which includes giving the site a new look and making it more user friendly.
During the migration information may exist both at the old and new site, however slowly pages should start to be located mainly at the new site. Please see the NAS Website for details.
Module Packaging
From Thecus Wiki
PAGE MOVED
This pages has been moved to the NAS Website as part of the migration process. Please go to the NAS Website and locate the updated version.
This page will remain for a period of time until the migration has been succesfully completed. However it will be in read-only mode for which reason it is likely to be out of date.
This page describes the preferred way to package a module. In other words it describes which files to include in the pacakge as well as the preferred way of naming the package.
At this point it is assumed that you have finished creating the actual module (eg. as described on the N2100 Module Development), meaning that you have a .mod file, say TESTMOD.mod
It is recommended to include the following files in the package (aside from the actual module):
- README: General notes about the module, including apects to be aware of.
- INSTALL: Notes specifically related to the installation process.
- CHANGELOG: Description of changes since last version
You can use whatever compression method you prefer, such as zip, tar/gzip, rar etc. However it is highly recommended to follow this naming convention in order not to confuse modules of different versions and platforms.
Name the module package as follows:
<PLATFORM>-<NAME>-<VERSION>.<EXT>
Eg.
N2100-TESTMOD-1.0.00.zip N5200-GOODMOD-3.0.20.tar.gz
And thats it!