Hacker News Reader

Comment by snazz | Hacker News Reader

It’s funny that this README just assumes you have Node installed. Not having ever used it before, I had no idea what “npx” was or did. A “requirements” or “dependencies” section on the homepage would be nice, as would a comparison to other static site generators.

View on HN

Hell I have node and I don't even know what npx is. There should be a PEP8 for readme's. Can a 5 year old figure out your README? or something close to that extent. Otherwise their README is fine.

It is explained in the next paragraph what "npx" is:

> Yep. cool? “npx” allows you to run a temporary package, which will be deleted right after each use. Use this command to try and experience how Fine works. Doesn’t hurt to try, huh?

It's not a satisfactory explanation for the layman, because it still assumes that you know that a package refers to something on npm, and that npx itself is a part of Node/npm.

All it would really need to say is that it requires a recent version of Node.

Thanks. I have need something like this, but the web pages do not indicate anything about what it does, how it works or how to use it. I don't have Node installed, either, so it was a waste of time clicking through. I wonder why it was posted here?

It’s not that well written but ‘why was it posted’ because it doesn’t introduce npx is a bit much.

It’s also easily put together by the next example (uses npm) and google, if you were actually interested in the subject.

I see tons of Rust CLI projects with precious little about their requirements.

Sure, a not complete README is nice, but not having one is not exactly weird.

Reply on news.ycombinator.com