search

dictation-toolbox / natlink

Natlink provides the interface between Dragon and python
Other
25 stars 17 forks source link

Documentation conventions, py -m command vs python -m command vs command #182

Open dougransom opened 6 months ago

dougransom commented 6 months ago

Throughout documentation examples use py -m ... which I think leads users astray. I don't think most folks use 'py' to run python scripts, they use 'python'. Who knows what python they will even get?

I think we should say 'pip install' not 'python -m pip install', or for any command we need them to run like 'flit install' which should write 'flit install', not 'py -m flit install'.

We should ask users who are going to use the command line to write an activate.bat which puts the correct python and python/scripts folders in the path.

LexiconCode commented 6 months ago

The reason this is done is because py works when python is not on path. The installer doesn't install python to path because other people have development systems which often 64-bit. Natlink a program should not take over path permanently

By default if natlink installs python it includes py launcher. It's done so we can make sure that people are using the right python interpreter.

However I suppose the reason why we have the environment.bat so they can get into it either way which is documented.

We should edit that bat file to make sure the environment set up so that your suggested pip works