Start the main CLI function with a short description of the package not just of this particular function. e.g. From the conda CLI: "conda is a tool for managing and deploying applications, environments and packages."
i.e. "COLD is a tool for reconstructing crystal structures from coded laue diffraction data"?
Add more detailed description paragraph in the middle which highlights some more detailed features.
i.e. "With COLD you can collect data faster by scanning the entire sample simultaneously [insert few more sentences about it]"
Add more detailed description about what users can expect COLD to do to their file-system? e.g. What folders and files will likely be created?
End with a link to the docs for the config file. Because the config file contains MUCH more than can be described in a quick help statement.
github-actions[bot]
commented
2 years ago
Start the main CLI function with a short description of the package not just of this particular function. e.g. From the conda CLI: "conda is a tool for managing and deploying applications, environments and packages."
i.e. "COLD is a tool for reconstructing crystal structures from coded laue diffraction data"?
Add more detailed description paragraph in the middle which highlights some more detailed features.
i.e. "With COLD you can collect data faster by scanning the entire sample simultaneously [insert few more sentences about it]"
Add more detailed description about what users can expect COLD to do to their file-system? e.g. What folders and files will likely be created?
End with a link to the docs for the config file. Because the config file contains MUCH more than can be described in a quick help statement.