Skip to content

Conversation

@rm5248
Copy link
Contributor

@rm5248 rm5248 commented Sep 28, 2024

Add directions on how to use the STM32CubeIDE in order to build and run Zephyr applications.

Adapted from the following discussion: #69812

https://builds.zephyrproject.io/zephyr/pr/79148/docs/develop/tools/stm32cubeide.html

@github-actions
Copy link

Hello @rm5248, and thank you very much for your first pull request to the Zephyr project!
Our Continuous Integration pipeline will execute a series of checks on your Pull Request commit messages and code, and you are expected to address any failures by updating the PR. Please take a look at our commit message guidelines to find out how to format your commit messages, and at our contribution workflow to understand how to update your Pull Request. If you haven't already, please make sure to review the project's Contributor Expectations and update (by amending and force-pushing the commits) your pull request if necessary.
If you are stuck or need help please join us on Discord and ask your question there. Additionally, you can escalate the review when applicable. 😊

Copy link
Contributor

@mathieuchopstm mathieuchopstm left a comment

Choose a reason for hiding this comment

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

Thanks for this useful addition!
Tested and works fine on my side when following these instructions.
A few improvement proposals, otherwise LGTM.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a note indicating that config_default comes from the default build folder name chosen by CubeIDE is worth adding here? If the user changes the build folder, or the default name changes in the future, this could save headaches.

@rm5248 rm5248 force-pushed the add-stm32cube-directions branch from dd1a4ec to 7919cd2 Compare October 23, 2024 18:51
Copy link
Member

@erwango erwango left a comment

Choose a reason for hiding this comment

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

In commit message, you can't use this address:
Mathieu CHOPLAIN <[email protected]>

Please use Mathieu Choplain <[email protected]>

Copy link
Contributor

@kartben kartben left a comment

Choose a reason for hiding this comment

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

very nice, thanks for this work!

Copy link
Contributor

Choose a reason for hiding this comment

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

please convert images to .webp (you may use e..g cwebp) -- it should cut the file size in half if not more, which is important as they end up in the evergrowing Git repo that everyone uses :)
https://docs.zephyrproject.org/latest/contribute/documentation/guidelines.html#images for reference

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
in the `Getting Started Guide <https://docs.zephyrproject.org/latest/getting_started/index.html>`_.
in the :ref:`getting_started`.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
:menuselection:`CDT User Settings Entires` option.
:guilabel:`CDT User Settings Entires` option.

Comment on lines 37 to 32
Copy link
Contributor

Choose a reason for hiding this comment

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

please make the image::s figure::s instead, including a caption and an alt description (see https://docs.zephyrproject.org/latest/contribute/documentation/guidelines.html#images). This will add some breathing room in the text but also help with accessibility

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
These directions have been validated to work with 1.16.0 of the IDE.
These directions have been validated to work with version 1.16.0 of the IDE.

Copy link
Contributor

Choose a reason for hiding this comment

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

This could be removed.

Comment on lines 22 to 23
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#. Setup a Zephyr workspace such that west is available. This can be followed
in the `Getting Started Guide <https://docs.zephyrproject.org/latest/getting_started/index.html>`_.
#. Setup a Zephyr workspace by following the `Getting Started Guide <https://docs.zephyrproject.org/latest/getting_started/index.html>`_.

Comment on lines 43 to 44
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
folder that you will open should have the ``CMakeLists.txt`` and ``prj.conf``
in it.
folder that is opened should contain the ``CMakeLists.txt`` and ``prj.conf`` files.

@JarmouniA
Copy link
Contributor

@rm5248 squash the last 3 commits into the 1st one.

@rm5248 rm5248 force-pushed the add-stm32cube-directions branch 2 times, most recently from 0c7044b to 7723cbe Compare October 28, 2024 18:57
@kartben kartben added this to the v4.0.0 milestone Oct 29, 2024
Add directions on using STM32CubeIDE for developing Zephyr.

Signed-off-by: Robert Middleton <[email protected]>
@kartben kartben force-pushed the add-stm32cube-directions branch from 7723cbe to 98a44d4 Compare November 12, 2024 10:38
Copy link
Contributor

@kartben kartben left a comment

Choose a reason for hiding this comment

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

just fixed a minor formatting glitch in the first numbered list item.
LGTM otherwise, if STM32 peeps are happy with it :)

@mmahadevan108 mmahadevan108 merged commit 05ad0ae into zephyrproject-rtos:main Nov 12, 2024
16 checks passed
@github-actions
Copy link

Hi @rm5248!
Congratulations on getting your very first Zephyr pull request merged 🎉🥳. This is a fantastic achievement, and we're thrilled to have you as part of our community!

To celebrate this milestone and showcase your contribution, we'd love to award you the Zephyr Technical Contributor badge. If you're interested, please claim your badge by filling out this form: Claim Your Zephyr Badge.

Thank you for your valuable input, and we look forward to seeing more of your contributions in the future! 🪁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants