Skip to content

README: Middlewares holds FreeRTOS and the LibXR submodule - #27

Merged
Jiu-xiao merged 1 commit into
devfrom
docs/middlewares-list
Oct 4, 2026
Merged

Jiu-xiao merged 1 commit into
devfrom
docs/middlewares-list

Conversation

@Jiu-xiao

@Jiu-xiao Jiu-xiao commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

The directory list named an ST USB Device library under Middlewares/; the project has only Third_Party/FreeRTOS and Third_Party/LibXR, and USB comes from LibXR's XRUSB.

Summary by Sourcery

Align the README middleware documentation with the project’s actual dependencies.

Enhancements:

  • Correct the README directory listing to accurately describe the middleware dependencies as FreeRTOS and the LibXR submodule.

Documentation:

  • Update the README to remove the incorrect reference to the ST USB Device library.

The project has no ST USB Device library; USB comes from LibXR's XRUSB.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sorry @Jiu-xiao, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 5 days and 12 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Oct 4, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the README’s middleware directory listing so it accurately documents FreeRTOS and the LibXR submodule, removing the nonexistent standalone ST USB Device library reference.

File-Level Changes

Change Details Files
Correct the README directory description to match the repository’s actual middleware dependencies.
  • Remove the outdated reference to an ST USB Device library.
  • Retain FreeRTOS and the LibXR submodule as the middleware contents, with USB functionality provided through LibXR’s XRUSB.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@Jiu-xiao
Jiu-xiao merged commit ac93dd7 into dev Oct 4, 2026
14 checks passed
@Jiu-xiao
Jiu-xiao deleted the docs/middlewares-list branch October 4, 2026 23:32
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.

1 participant