openbikesensor / openbikesensor.github.io

The OpenBikeSensor project website and documentation
https://openbikesensor.org
GNU Lesser General Public License v3.0
28 stars 32 forks source link

Add installation instruction for the esptool in a Python virtual environment. #131

Closed SubOptimal closed 2 years ago

SubOptimal commented 2 years ago

To avoid confusion about different ways to call the flashing tool esptool in Linux, the list of possibilities was reduced to two ways. One way to install the tool via the package system of the Linux distribution and the other in a Python virtual environment. Both ways are focusing on users with basic Linux experience. For which we assume to be able to adapt the instructions for their specific setup. For users with less Linux experience the flashing method via the browser should be the preferred way.

opatut commented 2 years ago

Why would you remove the list of possible command names? Different distributions package it under different names, that's why we had that list. I found it rather intutitive to work with :shrug:

we assume to be able to adapt the instructions for their specific setup

This is actually not the case and we had people very confused in the past because they would type the command esptool, then get a bash: command not found: esptool, and then they'd give up instead of trying esptool.py.

I do like the expanded installation instructions.

opatut commented 2 years ago

By the way, esptool.py is canonical:

https://github.com/espressif/esptool/blob/41ceca0a72266960252717b3181389902fd89d55/setup.py#L63

Most distributions do it incorrectly, naming the binary esptool instead of esptool.py in their packages ;(

SubOptimal commented 2 years ago

I re-added the other possible commands.