search

ideasman42 / nerd-dictation

Simple, hackable offline speech to text - using the VOSK-API.
GNU General Public License v3.0
1.21k stars 104 forks source link

Pip instructions are incorrect #126

Open morgannunan opened 1 month ago

morgannunan commented 1 month ago

The instructions to install this via pip just say pip install package/python.

ideasman42 commented 1 month ago

What is the error you're getting?

morgannunan commented 1 month ago

It's just not clear to me how this would install nerd-dictation. Am I supposed to first install vosk with pip, then clone nerd-dictation with git, then cd into it, get the language model, and then run pip install package/python to finish installing nerd-dictation?

ideasman42 commented 1 month ago

nerd-dictation is a stand alone script, there is no need to install it, you may symlink the script to ~/.local/bin/ or some other location in your $PATH, I'd still be interested to know the errors you rain into.

Moini commented 1 week ago

Works for me - you need to run the given command from the nerddictation root folder.

@ideasman Installation is necessary for elograf. Simple symlinking probably will not take the modules with it, so unless you want to copy the whole git repo into the bin folder... it makes more sense to install.

morgannunan commented 1 week ago

I get it. I have to cd into the installl folder, then run pip install package/python and it will install whatever package is present in the current folder. This was the part that didn't make sense to me. Maybe that's ignorant of me, but you might consider editing these instructions, like so:

To install nerd-dictaiton as a package from pip, run pip install package/python from within the nerd-dictation directory.

Moini commented 1 week ago

Yes. package/python is a path, not some kind of magic command (which I thought at first, too :) ).