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

docs: simplify installation instructions #203

Merged
merged 4 commits into from
Oct 2, 2024

Conversation

mojomex
Copy link
Collaborator

@mojomex mojomex commented Oct 1, 2024

PR Type

  • Improvement

Related Links

Description

Simplify the readme/installation pages:

  • remove the comment about the TCP-enabled transport drivers as they are installed automatically and are now prefixed by boost_ and thus not conflicting with ROS' transport_drivers anymore
  • remove the recommendation to create a src directory and instead recommend direct cloning
    • creating a src directory is one extra step which is not necessary
    • some IDEs/tools expect config files, e.g. .clang-tidy to be in the project root, not src
  • update the link to our about page

Pre-Review Checklist for the PR Author

PR Author should check the checkboxes below when creating the PR.

  • Assign PR to reviewer

Checklist for the PR Reviewer

Reviewers should check the checkboxes below before approval.

  • Commits are properly organized and messages are according to the guideline
  • (Optional) Unit tests have been written for new behavior
  • PR title describes the changes

Post-Review Checklist for the PR Author

PR Author should check the checkboxes below before merging.

  • All open points are addressed and tracked via issues or tickets

CI Checks

  • Build and test for PR: Required to pass before the merge.

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
@mojomex mojomex requested a review from drwnz October 1, 2024 09:53
@mojomex mojomex self-assigned this Oct 1, 2024
Signed-off-by: David Wong <david.wong@tier4.jp>
Copy link

sonarcloud bot commented Oct 1, 2024

# Build Nebula
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXPORT_COMPILE_COMMANDS=1
Copy link
Collaborator

@drwnz drwnz Oct 1, 2024

Choose a reason for hiding this comment

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

CMAKE_EXPORT_COMPILE_COMMANDS - I'm guessing this is for Clang? With this option set I do get a compile_commands.json but I also get a CMake Warning:

Manually-specified variables were not used by the project:
CMAKE_EXPORT_COMPILE_COMMANDS

I added a commit that adds an ignore to the meta project to remove the warning.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@drwnz This setting applies to all compilers and is used by IDEs/language servers to analyze the code as pointed out by @knzo25 🙌

@mojomex mojomex merged commit d7cb4a5 into tier4:main Oct 2, 2024
11 checks passed
@mojomex mojomex deleted the docs/simplify-install-instructions branch October 2, 2024 01:37
mojomex added a commit to mojomex/nebula that referenced this pull request Oct 2, 2024
* docs: remove obsolete note about transport drivers

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* docs: remove recommendation to clone into `src` directory

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore: update link to about page

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore: add cmake ignore to meta package

Signed-off-by: David Wong <david.wong@tier4.jp>

---------

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: David Wong <david.wong@tier4.jp>
Co-authored-by: David Wong <david.wong@tier4.jp>
mojomex added a commit that referenced this pull request Oct 3, 2024
* chore: fix case style in common modules and their usages

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore(hesai): fix case style

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore(continental): fix case style

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore(robosense): fix case style

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore(velodyne): fix case style

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore: fix typos in the SetVelocity Vehicle function (#204)

* docs: simplify installation instructions (#203)

* docs: remove obsolete note about transport drivers

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* docs: remove recommendation to clone into `src` directory

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore: update link to about page

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore: add cmake ignore to meta package

Signed-off-by: David Wong <david.wong@tier4.jp>

---------

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: David Wong <david.wong@tier4.jp>
Co-authored-by: David Wong <david.wong@tier4.jp>

---------

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: David Wong <david.wong@tier4.jp>
Co-authored-by: JonasKrug <JonasKrug@users.noreply.github.com>
Co-authored-by: David Wong <david.wong@tier4.jp>
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.

3 participants