-
Notifications
You must be signed in to change notification settings - Fork 437
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update and simplify README #591
Conversation
|
||
## Disclaimer | ||
* Standard C/C++ toolchain | ||
* Node 4 or newer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
node is not a dependency, if people build from source, and we don't depend on c++ toolchain
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good points. The reason I put Node there is because it comes with npm
but I could clarify that (when installing the package) and fix the other one.
I like the new README in general, it looks more professional, sorry for my bad English :-) |
Thanks. Regarding the licensing and building from source sections, what do you think about moving them to a separate markdown file or a wiki page and just have a very clear link under the section header? I think it's great to make the extra information available but maybe not include all of it directly in the main README. I worry that seeing all the detailed build instructions right away could be intimidating to users who don't plan to work on the source. |
I agree, would you mind have a file in docs about building instructions? |
@bobzhang I updated the PR based on your feedback. The build instructions are in an external file and the license section is added back in (I tried to restructure some of the links and stuff to make it a bit clearer but can revert that part if you prefer). |
Thanks, looks much better now. Except for the explanation of |
Okay, does that part look better now? |
thanks! |
This PR updates and simplifies the README. In particular, I've updated the build instructions to just mention
npm install
. I've removed some extra commentary in the README that I think might be better suited to the wiki or other docs. If you find this PR acceptable I could help add the commentary (licensing, status) to the wiki and include links in the README.