(docs) Installation instructions encourage pip3 (a dev tool)

[bruceleerabbit]

These are the first installation instructions that users encounter:

https://github.com/argosopentech/argos-translate#install-from-pypi

I simply ran the pip3 commands and got burned by a couple factors. pip3 was never designed for end users. It’s a quite rough tool meant for developers. It’s improperly documented and gives stack dumps when there is a problem, as opposed to a clear error msg.

Proper packaging for Debian should be a future goal of this project.

For the moment while pip3 is in play, the installation instructions should warn users that a huge 750mb file will fetched. Some people are on crappy measured rate Internet connections and that 750mb will suck bandwidth quotas dry. It’s a quite nasty surprise because when that happens it costs the user money, and on top of that pip3 is incapable of crash recovery. So the user must start again from the beginning. pip3 does not have an option to output URLs so that users can easily use wget -c -- it requires some deep investigation.

After getting burnt by the nasty lack of crash recovery on a huge file, it occured to me that the installation instructions lower on the page would have permitted crash recovery (I think):

https://github.com/argosopentech/argos-translate#python-source-installation

It’s labelled as “source installation”, so users who don’t need the source will generally overlook that. But IIUC git includes crash recovery. It is the better approach, so it should be the first installation option mentioned. I would label it as “source installation (with crash recovery)” and move the pip3-only method below it with a label like “Install from PyPI (no crash recovery!)”.

Note that I’m not sure git offers crash recovery on a partial file. It may download incomplete files from the start again (though still better than pip3). Perhaps a third set of installation instructions should show how to download the files using wget.