Stuff we need to document in the README and/or documentation githubpage - please expand the list if needed! - [ ] general functionality of package - [ ] installation instructions - [ ] how to use as library: api's, example (entry script might be enough) - [ ] usage and inputs/outputs of package when used via entry script - [ ] description of (required?) input directory tree structure
Stuff we need to document in the README and/or documentation githubpage - please expand the list if needed!