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

[RJD-1201] Update Quick start / Build instructions #1386

Merged
merged 15 commits into from
Sep 19, 2024

Conversation

SzymonParapura
Copy link
Contributor

@SzymonParapura SzymonParapura commented Sep 17, 2024

Description

Abstract

Update the Quick Start and Build Instructions in the ss2 documentation.

Details

Updated Files:

  • QuickStart.md
    
  • BuildInstructions.md
    
  • random_test.launch.py
    

The random_test.launch.py file was modified to add support for the architecture types "awf/universe/20230906" and "awf/universe/20240605". Without these changes, the random_test_runner could not be executed.

References

Jira ticket: link

Destructive Changes

There are no destructive changes

Known Limitations

N/A

SzymonParapura and others added 13 commits September 11, 2024 12:36
- Added expected build result for colcon build command.
- Updated instructions to provide clearer guidance through the process of building Scenario Simulator v2 (SS2).
- Updated instructions to provide clearer guidance through the process of building SS2
 - Added a new line at the end of the file
 - Fixed an issue with commas and periods
 - Fixed an issue with commas and periods
 - Updated launch script
 - Updated Usage.md
 - Updated default value for the architecture_type parameter
 - Fixed an issue with inserted images
- Fixed an issue with an image title
@SzymonParapura SzymonParapura added the bump minor If this pull request merged, bump minor version of the scenario_simulator_v2 label Sep 17, 2024
@SzymonParapura SzymonParapura self-assigned this Sep 17, 2024
Copy link

github-actions bot commented Sep 17, 2024

Checklist for reviewers ☑️

All references to "You" in the following text refer to the code reviewer.

  • Is this pull request written in a way that is easy to read from a third-party perspective?
  • Is there sufficient information (background, purpose, specification, algorithm description, list of disruptive changes, and migration guide) in the description of this pull request?
  • If this pull request contains a destructive change, does this pull request contain the migration guide?
  • Labels of this pull request are valid?
  • All unit tests/integration tests are included in this pull request? If you think adding test cases is unnecessary, please describe why and cross out this line.
  • The documentation for this pull request is enough? If you think adding documents for this pull request is unnecessary, please describe why and cross out this line.

- Updated link to cuDNN licencse
@SzymonParapura SzymonParapura changed the title [RJD-1201] Update Quick start / build instructions [RJD-1201] Update Quick start / Build instructions Sep 17, 2024
@hakuturu583 hakuturu583 self-requested a review September 19, 2024 03:28
@hakuturu583 hakuturu583 merged commit 091eeaa into master Sep 19, 2024
10 checks passed
@github-actions github-actions bot deleted the RJD-1201/documentation_update branch September 19, 2024 04:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump minor If this pull request merged, bump minor version of the scenario_simulator_v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants