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

Update documentation #357

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tyler-yankee
Copy link
Collaborator

@tyler-yankee tyler-yankee commented Jan 17, 2025

Updates to the docs for each example include the following:

  • remove top-level README reference to old scripts/ directory
  • make consistent calls to install_prereqs using sudo, and fix 'install_prereqs.sh' -> 'install_prereqs'
  • make consistent CMake build directories inside their respective example source tree, rather than some at the top level
  • sync with [drake_cmake_installed] Replace broken particles example #355 to remove broken example and any reference to it
  • remove unnecessary gtest local install/build in drake_cmake_external as it is included in the repo

This addresses #353.


This change is Reviewable

Copy link
Collaborator Author

@tyler-yankee tyler-yankee left a comment

Choose a reason for hiding this comment

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

Reviewable status: 1 unresolved discussion, LGTM missing from assignee betsymcphail, platform LGTM missing (waiting on @BetsyMcPhail)


a discussion (no related file):
+@BetsyMcPhail for feature review, please!

Copy link
Contributor

@BetsyMcPhail BetsyMcPhail left a comment

Choose a reason for hiding this comment

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

Reviewed 6 of 6 files at r1, all commit messages.
Reviewable status: 5 unresolved discussions, LGTM missing from assignee betsymcphail, platform LGTM missing (waiting on @tyler-yankee)


drake_bazel_external/README.md line 14 at r1 (raw file):

sudo setup/install_prereqs

See discussion in #359. @tyler-yankee what are your thoughts on how to proceed here?


drake_cmake_external/CMakeLists.txt line 101 at r1 (raw file):

  # Or from a commit (download and use "shasum -a 256 'xxx.tar.gz'" on it to
  # get the URL_HASH.
  # URL https://github.com/RobotLocomotion/drake/archive/962483669d015ee2618585ace2c884598fbadbb5.tar.gz

It's not clear to me why these were updated?


drake_cmake_installed/README.md line 21 at r1 (raw file):

# 1) A specific version (date-stamped)
# curl -O https://drake-packages.csail.mit.edu/drake/nightly/drake-20240214-jammy.tar.gz

BTW Some of the example lines begin with # and some don't. It seems like it would be more clear for the commands to not start with #?


README.md line 16 at r1 (raw file):

Scripts are provided for various CI instances in each example's respective subdirectory under `.github/`. The intended purpose of each is described below:

* `github_actions`:  exemplifies how to put a project depending on a Drake installation on GitHub Actions

Previously, github_actions and jenkins were subdirectories under scripts/continuous_integration. Please update this section to more accurately describe the current setup.

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