-
Notifications
You must be signed in to change notification settings - Fork 44
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
[Doc]Refine README in cpp about building #182
Conversation
Refine README in cpp about building.
🎊 PR Preview e99bb77 has been successfully built and deployed to https://alibaba-graphar-build-pr-182.surge.sh ![]() 🤖 By surge-preview |
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.
LGTM
cpp/README.rst
Outdated
@@ -101,7 +101,7 @@ After the building, you can install the GraphAr C++ library with: | |||
|
|||
.. code-block:: shell | |||
$ sudo make install | |||
$ sudo make install # run in directory you build, like build-relese, build and so on |
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.
build-release
@@ -57,7 +57,7 @@ Release build: | |||
$ mkdir build-release | |||
$ cd build-release | |||
$ cmake .. | |||
$ make -j8 # if you have 8 CPU cores, otherwise adjust | |||
$ make -j8 # if you have 8 CPU cores, otherwise adjust, use -j`nproc` for all cores |
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.
Maybe we can unify the usage of ".. code-block:: shell" ".. code-block::" and ".. code:: shell" in this file
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.
Thanks! I unified it in both README of cpp and README of spark.
Has any other place where I can make it better?
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.
Thanks! I unified it in both README of cpp and README of spark.
Has any other place where I can make it better?
Thanks for your contribution! This change looks good to me now.
Proposed changes
Refine build command in README in cpp.
Types of changes
What types of changes does your code introduce to GraphAr?
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...