Skip to content

Split README, add more instructions and a few fixes to make llnode easier to contribute#177

Closed
joyeecheung wants to merge 3 commits into
nodejs:masterfrom
joyeecheung:os-install
Closed

Split README, add more instructions and a few fixes to make llnode easier to contribute#177
joyeecheung wants to merge 3 commits into
nodejs:masterfrom
joyeecheung:os-install

Conversation

@joyeecheung

Copy link
Copy Markdown
Member

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

  • 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.
@joyeecheung

joyeecheung commented Mar 18, 2018

Copy link
Copy Markdown
Member Author

BTW the clang-format in the latest depot_tools is clang-format version 5.0.0 (trunk 302580). The latest stable from the LLVM website is clang-format version 5.0.1 (tags/RELEASE_501/final). I chose the one from the website.

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

Copy link
Copy Markdown
Member

Sorry, seems I overlooked the notification for this PR. Is this subsumed by #182 and/or #185?

@joyeecheung

Copy link
Copy Markdown
Member Author

@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

Labels

None yet

2 participants