-
Notifications
You must be signed in to change notification settings - Fork 143
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
<!-- Thanks for your contribution! Please read this comment in its entirety. It's quite important. When a contributor merges the pull request, the title and the description will be used to build the merge commit! ### Pull Request TITLE It should be in the following format: [ 12345: Summary of the changes made ] Where 12345 is the corresponding Github Issue OR [ Summary of the changes made ] If it's solving something trivial, like fixing a typo. --> ### Linked issues <!-- Link the Issue(s) this Pull Request is related to. Each PR should link to at least one issue, in the form: Use one line for each Issue. This allows auto-closing the related issue when the fix is merged. Fixes #12345 Fixes #54345 --> [Build size because missing release variant in the docs]( #62) [Missing --prefix to the install step](#65) [Missing --recursive flag while cloning](#63) ### Summarize your change. - Refresh the documentation to have all the full build steps in the main README.md file with the common build aliases equivalent. - Moves doc into docs. ### Describe the reason for the change. - Blind spots in the OpenRV documentation cause multiple issues. - The documentation root folder should be named `docs,` as requested by the documentation team for the future ReadTheDocs integration. ### Describe what you have tested and on which operating system. - [ ] Windows aliases - [ ] MacOS aliases - [ ] Linux aliases - [ ] Documentation link changes ### Add a list of changes and note any that might need special attention during the review. I updated the common build alias files to use `main_executable` instead of a mix of `RV` and `rv`. This needs to be tested on all OSes. I moved the doc folder to the docs folder. I think changed all occurrences to `doc`, but it's to be double-checked. ### If possible, provide screenshots. Main Readme Render: https://github.com/geffrak/OpenRV/tree/docs#readme Windows setup doc Render: https://github.com/geffrak/OpenRV/blob/docs/docs/build_system/config_windows.md macOS setup doc Render: https://github.com/geffrak/OpenRV/blob/docs/docs/build_system/config_macos.md Linux setup doc Render: https://github.com/geffrak/OpenRV/blob/docs/docs/build_system/config_linux_centos7.md --------- Signed-off-by: Kerby Geffrard <[email protected]>
- Loading branch information
Showing
153 changed files
with
157 additions
and
162 deletions.
There are no files selected for viewing
This file contains 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 file contains 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 file contains 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 file contains 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 file contains 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
Oops, something went wrong.