-
Notifications
You must be signed in to change notification settings - Fork 8.4k
Add directions in using STM32CubeIDE #79148
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
Add directions in using STM32CubeIDE #79148
Conversation
|
Hello @rm5248, and thank you very much for your first pull request to the Zephyr project! |
e54c154 to
9018176
Compare
mathieuchopstm
left a comment
There was a problem hiding this 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.
doc/develop/tools/stm32cubeide.rst
Outdated
There was a problem hiding this comment.
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.
dd1a4ec to
7919cd2
Compare
There was a problem hiding this 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]>
kartben
left a comment
There was a problem hiding this 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!
There was a problem hiding this comment.
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
doc/develop/tools/stm32cubeide.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| in the `Getting Started Guide <https://docs.zephyrproject.org/latest/getting_started/index.html>`_. | |
| in the :ref:`getting_started`. |
doc/develop/tools/stm32cubeide.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| :menuselection:`CDT User Settings Entires` option. | |
| :guilabel:`CDT User Settings Entires` option. |
doc/develop/tools/stm32cubeide.rst
Outdated
There was a problem hiding this comment.
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
doc/develop/tools/stm32cubeide.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
doc/develop/tools/stm32cubeide.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could be removed.
doc/develop/tools/stm32cubeide.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| #. 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>`_. |
doc/develop/tools/stm32cubeide.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
|
@rm5248 squash the last 3 commits into the 1st one. |
0c7044b to
7723cbe
Compare
Add directions on using STM32CubeIDE for developing Zephyr. Signed-off-by: Robert Middleton <[email protected]>
7723cbe to
98a44d4
Compare
kartben
left a comment
There was a problem hiding this 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 :)
|
Hi @rm5248! 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! 🪁 |
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