TissueEngineeringLab / MyoFInDer

Python interface for automatic calculation of the fusion index in muscle cell cultures
https://tissueengineeringlab.github.io/MyoFInDer/
GNU General Public License v3.0
3 stars 1 forks source link

Add warnings at the beginning of command-line installation sections of the documentation #21

Closed WeisLeDocto closed 9 months ago

WeisLeDocto commented 9 months ago

I was reported a case of a user at the Tissue Engineering Lab who, (thinking they) failed to install MyoFInDer with the Windows installer, tried to run more or less randomly in a terminal other commands they could see on the Installation page.

It should be more explicitly mentioned and reminded, at least in the section dedicated to the Windows installation, that the command line installation is only intended for experimented users. Probably just adding a warning at the beginning of each sub-section displaying terminal commands is fine. This warning should redirect users towards section 1.3, and encourage users facing issues to request help instead of trying commands they do not understand.