Best practices for building Slax modules

written by Tomas M. 6 years ago

If you're writing build scripts to produce Slax modules, always bear in mind that there will be other users using your module. Here are some of the best practices you should follow in order to make your modules smaller, easier to install, and more useful for Slax users:

  • Use minimum runtime dependencies. If the software you're compiling requires other libraries, which are not absolutely essential for the software to run properly, always check if there are some compile-time options to compile it without the given dependency. If the compilation requires perl or python or other module but the software itself runs without it, make sure to distinguish compile-time dependencies and do not include those in regular dependency list.

  • Write good descriptions. The better description you write for your module, the easier it will be for the user to find your module (by fulltext search) and to understand what is it useful for.

  • That is all what I can think of for now. I will add this to the documentation section and I will be happy for your suggestions what you feel is a good practice for building modules (writing build scripts). Thank you.

    Tomas M.

    (c) 2019, Tomas M; rss