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
4 stars 1 forks source link

Add picture in documentation showing what the `pip` install window looks like #18

Closed WeisLeDocto closed 9 months ago

WeisLeDocto commented 9 months ago

After installing the MyoFInDer program with the Windows installer, when users start it for the very first time, it opens a terminal window and creates a Python virtual environment. In this environment, it installs the required dependencies of the myofinder Python module, and finally the myofinder module itself.

For users not familiar with pip installs, this step can be a source of confusion and make them believe that the installation is broken. Because a picture is worth a thousand words, it would certainly be reassuring for users to include a picture of the pip install process in the documentation, and describe it as a normal step. This picture and its description should be present in sections 1.3, 1.4.2 and 2.3 of the Installation page.