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

Feature/improved-documentation #59

Merged
merged 9 commits into from
Jan 18, 2024

Conversation

Harvendois
Copy link
Collaborator

PR for Improved Documentation
by Jungha Cho

Key Changes:

  1. README.md improved for easier installation of the toolbox (commands like NVidia runtime and Xserver displays are omitted).
  2. Windows.md created to guide Windows OS users installing the toolbox.
  3. contributing.rst under docs directory improved to catch errors and allow Windows user clearer guidance.
  4. CMakeLists.txt edited to add ASanitizer disable/enable option when compiling. This allows us to run both ASanitizer leak test and Valgrind tests easily.
  5. create_charuco_board.cpp edited to disable display-related codes (such as cv.imshow()), which were prone to make errors.

@rameau-fr rameau-fr requested a review from BAILOOL January 16, 2024 08:10
Copy link
Collaborator

@BAILOOL BAILOOL left a comment

Choose a reason for hiding this comment

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

This PR looks great. Thank you very much for this contribution. I have left a few minor comments.

Windows.md Outdated Show resolved Hide resolved
Windows.md Outdated Show resolved Hide resolved
Windows.md Outdated Show resolved Hide resolved
Windows.md Outdated Show resolved Hide resolved
Windows.md Outdated Show resolved Hide resolved
Windows.md Outdated Show resolved Hide resolved
Windows.md Outdated Show resolved Hide resolved
Windows.md Outdated Show resolved Hide resolved
@Harvendois
Copy link
Collaborator Author

Thank you for checking the PR in detail. I fixed all the minor comments that you have made and commited accordingly.

@BAILOOL BAILOOL self-requested a review January 18, 2024 16:59
@BAILOOL BAILOOL merged commit f6d6b7f into rameau-fr:master Jan 18, 2024
1 check passed
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.

2 participants