Fixed incorrect CMake flag and other typos #1026
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit makes a few small improvements to the README.md file: - Fixed incorrect CMake flag: DBUILD_DOCS → -DMATX_BUILD_DOCS - Corrected typos like "Jupyer" → "Jupyter" and "familarity" → "familiarity" - Fixed minor grammar and phrasing issues for better clarity These updates should make the documentation a bit easier to read and avoid confusion when building locally. Closes NVIDIA#1024
|
|
||
| ## Documentation | ||
| Documentation for MatX can be built locally as shown above with the `DBUILD_DOCS=ON` cmake flag. Building documentation requires the following to be installed: | ||
| Documentation for MatX can be built locally as shown above with the `-DMATX_BUILD_DOCS` cmake flag. Building documentation requires the following to be installed: |
There was a problem hiding this comment.
I would keep the =ON part for users not as familiar with CMake
|
|
||
| This will execute all unit tests defined. If you wish to execute a subset of tests, or run with different options, you | ||
| may run test/matx_test directly with parameters defined by [Google Test](https://github.com/google/googletest). To run matx_test | ||
| may run `test/matx_test` directly with parameters defined by [Google Test](https://github.com/google/googletest). To run matx_test |
There was a problem hiding this comment.
This PR was opened before we just merged df8c5b2
The new way to run it would be make test or make -j test
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit makes a few small improvements to the README.md file:
These updates should make the documentation a bit easier to read and avoid confusion when building locally.
Closes #1024