spech icon indicating copy to clipboard operation
spech copied to clipboard

No build instructions

Open atolstoy opened this issue 4 years ago • 5 comments

It would be nice to know how to actually build the 'spech' executable out of your Nodejs project. Thanks!

atolstoy avatar Feb 23 '21 12:02 atolstoy

What do you mean, global package install?

megahertz avatar Feb 23 '21 14:02 megahertz

Global or local, any installation will suffice. I mean that 'npm install' does not build the 'spech' executable you refer to in readme.md. What's the right way to get it then?

atolstoy avatar Feb 23 '21 15:02 atolstoy

When it's installed globally it should be available in a shell if npm is configured properly. But the best way is to use it through npx, you can find the example in the readme.

megahertz avatar Feb 24 '21 02:02 megahertz

When it's installed globally it should be available in a shell if npm is configured properly. But the best way is to use it through npx, you can find the example in the readme.

Well, I figured it out finally. I think you should update the documentation as long as some things are not obvious there. I'm pretty sure not everyone will guess where 'spech' resides without googling or doing things like 'npx which spech'. Also it's not clear where spech wants to find 'spech.config.json'. In $HOME? Current directory? etc.

atolstoy avatar Feb 24 '21 19:02 atolstoy

It's a default node.js behavior and I thought is hould be obvious, but maybe your're right and it does make sense to add a few words about that.

Also, I agree that I need to add information about config location.

megahertz avatar Feb 25 '21 07:02 megahertz