search

MyTooliT / ICOc

ICOc is a tool to control the ICOtronic system, acquire data, and test stationary transceiver units and sensory tool holders.
https://mytoolit.github.io/ICOc/
2 stars 0 forks source link

Readme Update #26

Closed LoydIrrving closed 2 years ago

LoydIrrving commented 2 years ago

The Readme could maybe need an update about calling icoc with additional parameters like -h , -n , -p , ... Could be seen as trivial but it wouldn't be bad to implement it in the Readme.

sanssecours commented 2 years ago

I think the most important command line switches should be already documented here.

sanssecours commented 2 years ago

I just moved most of the information from the readme into a new file in the Documentation directory. I also added two addtional links – one right at the start – to the online documentation to the readme. This should improve the chance that people discover that more information (than the one in the readme) is available.

In addition to the changes above I also added a link to the “tutorial” section section at the end of the section “Basic Usage”. Hopefully this way people find their way to the documentation of the command line interface more easily.

I will close this issue for now. Feel free to reopen it, if you still think that we should extend the documentation about the CLI interface.