search

fivdi / epoll

A low-level Node.js binding for the Linux epoll API
MIT License
84 stars 13 forks source link

Documentation Request: Can't install on Non-Linux systems #21

Closed lyzadanger closed 8 years ago

lyzadanger commented 8 years ago

Once I found the information that you can't install this module on non-Linux systems (https://github.com/fivdi/epoll/issues/12#issuecomment-138341563) it totally made sense—but I spent about 45 minutes trying to figure out what was going on before I was able to find that thread. The errors one gets suggest problems with node-gyp or bindings, which are both red herrings.

Would it be possible to add something to the README just calling this out, to save future people a little heartache and time?

fivdi commented 8 years ago

Sorry about that. You're quite right. I'll add the appropriate documentation.

fivdi commented 8 years ago

This has now been documented in the Installation section of the README.

@lyzadanger thanks for making the suggestion.