{"action":"created","issue":{"url":"https://api.github.com/repos/HDF-NI/hdf5.node/issues/22","repository_url":"https://api.github.com/repos/HDF-NI/hdf5.node","labels_url":"https://api.github.com/repos/HDF-NI/hdf5.node/issues/22/labels{/name}","comments_url":"https://api.github.com/repos/HDF-NI/hdf5.node/issues/22/comments","events_url":"https://api.github.com/repos/HDF-NI/hdf5.node/issues/22/events","html_url":"https://github.com/HDF-NI/hdf5.node/issues/22","id":142076818,"number":22,"title":"Documentation","user":{"login":"shumway","id":1060709,"avatar_url":"https://avatars.githubusercontent.com/u/1060709?v=3","gravatar_id":"","url":"https://api.github.com/users/shumway","html_url":"https://github.com/shumway","followers_url":"https://api.github.com/users/shumway/followers","following_url":"https://api.github.com/users/shumway/following{/other_user}","gists_url":"https://api.github.com/users/shumway/gists{/gist_id}","starred_url":"https://api.github.com/users/shumway/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shumway/subscriptions","organizations_url":"https://api.github.com/users/shumway/orgs","repos_url":"https://api.github.com/users/shumway/repos","events_url":"https://api.github.com/users/shumway/events{/privacy}","received_events_url":"https://api.github.com/users/shumway/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":13,"created_at":"2016-03-19T16:04:17Z","updated_at":"2016-03-31T15:10:31Z","closed_at":null,"body":"I spent about an hour evaluating hdf5.node, and didn't make much progress. There some misdirection in the README.md and the link to the api appears to be out of date. Looking at the recent commit history and test suites is helpful.\r\n\r\nI would suggest two concurrent steps to improve the documentation:\r\n\r\n1. Update the README.md to be similar in style and quality to popular node projects. The [README.md on express](https://www.npmjs.com/package/express) looks like a good model. Having README sections _Installation_,  _Features_, _Philosophy_,  and _Docs & Community_ would be helpful for users and contributors. It's important to say up front what hdf5.node does and does not do.\r\n\r\n2. Discussion forum on Gitter or Google Groups. Searchable discussion forums outside of issues could attract new developers, help focus the scope and goals, and nucleate new ideas. I've used Slack and Google Groups on other projects, but Gitter might be the best match for this project.\r\n\r\nIf other developers think this is a good idea. I can jump in and do this. I (or someone else) should probably set up the discussion group first, since I have some questions about the existing README.md file. I also need to make sure I understand the philosophy and vision behind this project. I don't want to add any additional confusion about the scope or goals.\r\n"},"comment":{"url":"https://api.github.com/repos/HDF-NI/hdf5.node/issues/comments/203980244","html_url":"https://github.com/HDF-NI/hdf5.node/issues/22#issuecomment-203980244","issue_url":"https://api.github.com/repos/HDF-NI/hdf5.node/issues/22","id":203980244,"user":{"login":"rimmartin","id":6502360,"avatar_url":"https://avatars.githubusercontent.com/u/6502360?v=3","gravatar_id":"","url":"https://api.github.com/users/rimmartin","html_url":"https://github.com/rimmartin","followers_url":"https://api.github.com/users/rimmartin/followers","following_url":"https://api.github.com/users/rimmartin/following{/other_user}","gists_url":"https://api.github.com/users/rimmartin/gists{/gist_id}","starred_url":"https://api.github.com/users/rimmartin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rimmartin/subscriptions","organizations_url":"https://api.github.com/users/rimmartin/orgs","repos_url":"https://api.github.com/users/rimmartin/repos","events_url":"https://api.github.com/users/rimmartin/events{/privacy}","received_events_url":"https://api.github.com/users/rimmartin/received_events","type":"User","site_admin":false},"created_at":"2016-03-31T15:10:31Z","updated_at":"2016-03-31T15:10:31Z","body":"For users who don't have hdf5 libraries installed at the path of https://github.com/HDF-NI/hdf5.node/blob/master/binding.gyp#L3\r\n\r\nthe hdf5_home_linux is now a switch:\r\n```$NODE_HOME/bin/npm install  --build-from-source --hdf5_home_linux=/home/user/NodeProjects/hdf5\r\n\r\n```\r\nand in dependent projects it also is passes thru\r\n\r\n```\r\ncd /home/user/NodeProjects/hdf5.ws\r\n$NODE_HOME/bin/npm install  --hdf5_home_linux=/home/user/NodeProjects/hdf5\r\n\r\n```\r\nand there is a different one for mac and windows which work similarly.\r\n\r\nWhere we talk about building we can reduce questions by stating this clearer than what I just did"}}