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

Add a new section about using Renode with PlatformIO #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added source/advanced/img/platformio-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions source/advanced/using-platformio.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
.. _platformio:

Using with PlatformIO
=====================

.. image:: img/platformio-logo.png
:target: https://platformio.org/?utm_source=https://renode.readthedocs.io

.. contents::
:local:

What is PlatformIO?
-------------------

`PlatformIO <https://platformio.org/?utm_source=https://renode.readthedocs.io>`__
is a cross-platform embedded development environment with Renode support maintained by
its developers.

Since Renode support within PlatformIO is not maintained by the Renode team,
please report any issues with PlatformIO directly to its developers in
`the official PlatformIO repositories <https://github.com/platformio>`_.

A detailed overview of the PlatformIO ecosystem and its philosophy can be
found in `the official PlatformIO documentation <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=https://renode.readthedocs.io>`_.

Installation
------------

* `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=https://renode.readthedocs.io>`_
is a toolset for embedded C/C++ development available on Windows, macOS and Linux
platforms
* `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html?utm_source=https://renode.readthedocs.io>`_
is a command-line tool that consists of multi-platform build system, platform and
library managers and other integration components. It can be used with a variety of
code development environments and allows integration with cloud platforms and web
services

Configuration
-------------

Please go through `the official PlatformIO configuration guide for Renode <https://docs.platformio.org/en/latest/plus/debug-tools/renode.html?utm_source=https://renode.readthedocs.io#configuration>`_.

Tutorials
---------

- `Developing Zephyr RTOS embedded applications on PlatformIO and simulating on Antmicro Renode
<https://www.zephyrproject.org/developing-zephyr-rtos-embedded-applications-on-platformio-and-simulating-on-antmicro-renode/>`_

Next Steps
----------

Here are some useful links for exploring the PlatformIO ecosystem:

- Learn more about `PIO Unified Debugger feature <https://docs.platformio.org/en/latest/plus/debugging.html?utm_source=https://renode.readthedocs.io>`_
- Get help from `PlatformIO community <https://community.platformio.org/?utm_source=https://renode.readthedocs.io>`_
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,4 @@
advanced/building_from_sources
advanced/platform_description_format
advanced/time_framework
advanced/using-platformio