Skip to main content

Archived Comments for: Ten recommendations for creating usable bioinformatics command line software

Back to article

  1. Some additional remarks

    Gert Wollny, Universidad Politechnica de Madrid

    14 January 2014

    Thanks for this nice roundup. I'd like to add a few comments: In addition, to #2 I would suggest that it is always a good idea to add a Unix style man page that also shows a working example. On one hand, it helps to discover programs by using the apropos command, and on the other hand, seeing a working example greatly helps to get started. #7 can be quite challenging - especially if your software used dynamically loadable plug-ins and configuration files. As an alternative, I'd suggest to make the software installable in a system-specific way that takes care of setting up the path properly. In that context, when you work on Linux, and your software is free and open source, it is also a good idea to get the software included into the corresponding packaging system. Here one can also assure #9, i.e. that by installing the software package all its required dependencies are installed as well (especially, if they are also free software).

    Competing interests