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

Improve the readability of README #851

Merged
merged 49 commits into from
Aug 16, 2024
Merged

Improve the readability of README #851

merged 49 commits into from
Aug 16, 2024

Conversation

LuisAlfredoNu
Copy link
Contributor

Before submitting

Please complete the following checklist when submitting a PR:

  • All new features must include a unit test.
    If you've fixed a bug or added code that should be tested, add a test to the
    tests directory!

  • All new functions and code must be clearly commented and documented.
    If you do make documentation changes, make sure that the docs build and
    render correctly by running make docs.

  • Ensure that the test suite passes, by running make test.

  • Add a new entry to the .github/CHANGELOG.md file, summarizing the
    change, and including a link back to the PR.

  • Ensure that code is properly formatted by running make format.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


Context:
Update README file on base on my early experience with the code

Description of the Change:
Improve readability of the code, changing long peaces of text with lists. Added subtitles to make more split section. Remove CMake compile instructions because are confusing and it can made it by pip. Try to make more clear the installation instructions for Lightning Kokkos.

Benefits:
Easier and faster way to read the README.

Possible Drawbacks:

Related GitHub Issues:

[sc-71287]

Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit .github/CHANGELOG.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@LuisAlfredoNu LuisAlfredoNu marked this pull request as ready for review August 13, 2024 15:53
Copy link

codecov bot commented Aug 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.57%. Comparing base (ec9e340) to head (6ca6d57).
Report is 1 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (ec9e340) and HEAD (6ca6d57). Click for more details.

HEAD has 36 uploads less than BASE
Flag BASE (ec9e340) HEAD (6ca6d57)
44 8
Additional details and impacted files
@@             Coverage Diff             @@
##           master     #851       +/-   ##
===========================================
- Coverage   98.41%   81.57%   -16.85%     
===========================================
  Files         113       17       -96     
  Lines       18647     1916    -16731     
===========================================
- Hits        18352     1563    -16789     
- Misses        295      353       +58     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@vincentmr vincentmr requested review from vincentmr and a team August 13, 2024 17:01
Copy link
Contributor

@vincentmr vincentmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @LuisAlfredoNu , looks good so far.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
Copy link
Member

@maliasadi maliasadi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @LuisAlfredoNu!

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
LuisAlfredoNu and others added 5 commits August 13, 2024 13:46
Co-authored-by: Ali Asadi <10773383+maliasadi@users.noreply.github.com>
Co-authored-by: Ali Asadi <10773383+maliasadi@users.noreply.github.com>
Copy link
Member

@multiphaseCFD multiphaseCFD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @LuisAlfredoNu ! Nice work. Just a few comments.

README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@vincentmr vincentmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple suggestions but looks good overall.

doc/CMakeOptions.rst Outdated Show resolved Hide resolved
doc/CMakeOptions.rst Outdated Show resolved Hide resolved
doc/CMakeOptions.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@vincentmr vincentmr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
LuisAlfredoNu and others added 4 commits August 16, 2024 08:56
Co-authored-by: Amintor Dusko <87949283+AmintorDusko@users.noreply.github.com>
Co-authored-by: Amintor Dusko <87949283+AmintorDusko@users.noreply.github.com>
Copy link
Contributor

@AmintorDusko AmintorDusko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thank you for the extra updates! 🙂
Feel free to merge it after @isaacdevlugt merges the PR #848 content.

Makefile Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
Copy link
Member

@maliasadi maliasadi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥳

@LuisAlfredoNu LuisAlfredoNu merged commit c591f46 into master Aug 16, 2024
77 of 78 checks passed
@LuisAlfredoNu LuisAlfredoNu deleted the kokkosNewAPI_readme branch August 16, 2024 20:18
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.

7 participants