Skip to content
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

Merged
merged 4 commits into from
Jun 6, 2023
Merged

Conversation

Thespica
Copy link
Contributor

@Thespica Thespica commented Jun 5, 2023

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 apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Checklist

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.

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

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...

Sorry, something went wrong.

Thespica added 2 commits June 5, 2023 12:44

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Refine README in cpp about building.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@CLAassistant
Copy link

CLAassistant commented Jun 5, 2023

CLA assistant check
All committers have signed the CLA.

@github-actions
Copy link

github-actions bot commented Jun 5, 2023

🎊 PR Preview e99bb77 has been successfully built and deployed to https://alibaba-graphar-build-pr-182.surge.sh

🤖 By surge-preview

Copy link
Contributor

@acezen acezen left a 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
Copy link
Contributor

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
Copy link
Contributor

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

Copy link
Contributor Author

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?

Copy link
Contributor

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.

Thespica added 2 commits June 5, 2023 20:19

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@acezen acezen merged commit 8ff4d99 into apache:main Jun 6, 2023
@acezen acezen added this to the Release v0.6.0 milestone Jun 6, 2023
@Thespica Thespica deleted the refine-doc branch July 15, 2023 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants