Skip to content

docs(IDE): update lip4a for upcoming v0.1.5 update#143

Open
pzhlkj6612 wants to merge 1 commit into
ruyisdk:zhfrom
pzhlkj6612:docs/lip4a-v0.1.5
Open

docs(IDE): update lip4a for upcoming v0.1.5 update#143
pzhlkj6612 wants to merge 1 commit into
ruyisdk:zhfrom
pzhlkj6612:docs/lip4a-v0.1.5

Conversation

@pzhlkj6612

@pzhlkj6612 pzhlkj6612 commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Hi!

Preview:

Screenshot_

@xijing21

.

Summary by Sourcery

Update the Lichee Pi 4A IDE Hello World guide for the new IDE and OS versions and to cover running and debugging via QEMU directly from the IDE.

Documentation:

  • Refresh the Lichee Pi 4A IDE Hello World tutorial for Ubuntu 24.04 and Eclipse Embedded C/C++ 2026-06.
  • Rewrite the virtual environment creation and application steps to use project-context menus instead of the Ruyi Venv view.
  • Expand the guide to include IDE-based run and debug configurations for QEMU, replacing manual terminal commands.

Signed-off-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
@sourcery-ai

sourcery-ai Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Updates the Sipeed Lichee Pi 4A IDE Hello World tutorial to reflect the upcoming v0.1.5 toolchain/IDE setup and adds integrated Run/Debug workflow instructions using Eclipse configurations and QEMU, replacing the previous terminal-based execution flow.

File-Level Changes

Change Details Files
Refresh environment and IDE version information for the tutorial.
  • Update OS version from Ubuntu 22.04.5 to Ubuntu 24.04.
  • Update IDE version from Eclipse 2025.12 to Eclipse 2026-06 (4.40.0).
IDE/cases/sipeed-lpi4a-ide-hello-world.md
Align virtual environment creation and application flow with new RuyiSDK IDE UI.
  • Change venv creation instructions from top-menu 'RuyiSDK' → 'Venv (Virtual Environments)' view to project-context-menu 'RuyiSDK' → 'New Venv...'.
  • Replace references to the 'Ruyi Venv' view with the new 'New virtual environment' and 'Apply venv' dialogs.
  • Adjust steps so venv is created, then applied to the project using 'Apply Venv...' from the project context menu.
IDE/cases/sipeed-lpi4a-ide-hello-world.md
Update build guidance to reflect new workflow and clarify artifacts.
  • Change guidance from possibly failing build to explicitly not building immediately after project creation.
  • Add explicit step to build the project via 'Build Project' from the project context menu after applying the venv.
  • Clarify that the build produces an executable with a .elf suffix.
IDE/cases/sipeed-lpi4a-ide-hello-world.md
Replace manual terminal-based QEMU execution with integrated Run/Debug configurations in Eclipse.
  • Add section on using Eclipse 'Run Configurations' under 'C/C++ Application' to run the .elf binary via QEMU using the automatically created configuration.
  • Add section on using Eclipse 'Debug Configurations' under 'C/C++ Remote Application' to debug the program, including notes on visible debug information such as threads and stack frames.
  • Remove the prior instructions to manually source the venv and run ruyi-qemu in a local terminal, along with related screenshots.
IDE/cases/sipeed-lpi4a-ide-hello-world.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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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