(docs) no man page and no (-h) help option

[bruceleerabbit]

After using this installation procedure (as root):

pip3 install --log-file ~/log/pip3-argostranslategui.err --log ~/log/pip3-argostranslategui.log --cache-dir /usr/local/pkgs argostranslategui

No man page was created. And when running argos-translate-gui -h, the GUI app is launched without giving help output. There should be a help page no matter how trivial it is so that users at least see that there are no options. Some things that should be covered by the help page:

• Since the GUI does take the liberty of connecting to the Internet (to download lang pairs), users would expect to see a --proxy option or absence thereof.

• A “bugs” section to tell users where to report bugs. (Which btw would ideally not force users to interact with MS Github.)

• Information about where lang pair libs are stored, most particularly because this differs from the CLI version.

doc bug 2:

These installation instructions should tell users how to install it systemwide (as root) and how to install it individually for one user:

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

ATM it makes no mention of root, but it should say to run as root if that’s the only way. I know from experimentation that those instructions work for root but I’ve not tested as a user.

Those installation instructions should also disclose 2 sizes: the download size for bandwidth calculations (for those on measured rate connections) and the installation size after everything is unpacked. Normal mainstream package managers (like aptitude) generally give users that info by design, but since pip3 is quite underdeveloped it does not give that info so it should be documented.

pip3 quietly dumps downloaded installation files in /tmp/ without telling users where the files are. This is dicey particularly if the download is interrupted. So I would propose suggesting use of the --cache-dir option to users. It might sound like too much hand-holding, but pip3 is a developer tool -- it was never intended for normal users. And pip3 is very poorly documented. That is, the man page and help page are inconsistent with each other and with what the software does.

[InerkyJad]

@PJ-Finlay are contributions still welcome? i'm getting into PyQt5 and i think i can contribute to both issues and add some minor improvements.

[PJ-Finlay]

@PJ-Finlay are contributions still welcome? i'm getting into PyQt5 and i think i can contribute to both issues and add some minor improvements.

Definitely!

There are multiple issues mentioned here so please break them into separate pull requests.