draeger-lab / ModelPolisher

ModelPolisher accesses the BiGG Models knowledgebase to annotate SBML models.
23 stars 7 forks source link

Add documentation of all command line arguments in README #66

Closed matthiaskoenig closed 5 years ago

matthiaskoenig commented 5 years ago

Currently the available command line arguments are not documented very well in the README/documentation. There should be a list of all arguments with a description of what they do, what the default is, and what behavior they change. In addition a list of examples showing different combinations of the command line arguments should be provided demonstrating typical use cases (these use cases should be added as tests to make sure they work).