update cse-cli, cmd & help response to v 0.2.0 #15
Conversation
cse-cli.md
Outdated
| It can simulate single FMUs and show the model descriptions. Besides being a necessary simulation tool, the CSE command line interface also serves as a demonstration for how client applications can make use of the CSE co-simulation library. | ||
| With the command-line interface, the co-simulation library is used to enable co-simulation from the command-line. | ||
|
|
||
| This page collects design ideas for the CSE command-line interface (CLI). | ||
|
|
||
| ### Functionality and design |
There was a problem hiding this comment.
This whole section should be removed or rewritten. The Confluence page it's taken from was just intended as a "design ideas" document, not as formal documentation, and this section really shows it.
There was a problem hiding this comment.
Could you review this page and update if any more information?
I'm not sure it's necessary to have all the help codes exposed in this page. Perhaps only the help to show the commands.
There was a problem hiding this comment.
I've noticed that you've included the help command in some cases but not in others. You may want to fix that. For example, you've included the line
> cse help run-single
before the help text for cse run-single, but you have not done the same for cse run.
There are also some commands like plain cse which just produces an error message, and cse --version, which don't seem necessary in a page like this. (Again, they were included in the document I wrote because it was a design spec, not documentation.)
None of the above are a big deal, though, and otherwise, I think this page looks good!
open issue #12