Split README, add more instructions and a few fixes to make llnode easier to contribute #177
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
BTW the clang-format in the latest depot_tools is |
Use the existing tools/gyp if it exists. It could be checked out from source instead of being linked to the node-gyp installation. Also corrects the names in the gyp linking routines. Also tries to find the built library in out/Release/obj.target/ if it's not in out/Release/
- Split the README into install.md, usage.md and develop.md under docs/. - Added OS-specific instructions on how to set up the prerequisites - Update the Contributing guide so it applies to llnode instead of node core. - Added instruction on how to install and run clang-format. Prefer the one available in the LLVM website.
|
@bnoordhuis The first commit is not necessary after #182 and the third commit needs a bit of rewrite after #185. The second commit is kind of trivial. I will open another doc PR after I resolve #185. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
configure: skip linking tools/gyp if it exists
Use the existing tools/gyp if it exists. It could be checked out
from source instead of being linked to the node-gyp installation.
Also corrects the names in the gyp linking routines.
Also tries to find the built library in out/Release/obj.target/
if it's not in out/Release/ (the original gyp does not move it).
src: format the src using clang-format 5.0.1
docs: split the README and update CONTRIBUTING.md
node core.
the one available in the LLVM website.