doc: develop: manifests: external: add arduino core #97726
Conversation
DhruvaG2000
force-pushed
the
arduino-api-doc
branch
2 times, most recently
from
4d9735b to
81d384c
Compare
DhruvaG2000
force-pushed
the
arduino-api-doc
branch
2 times, most recently
from
e43b494 to
09b3789
Compare
DhruvaG2000
changed the title
DhruvaG2000
force-pushed
the
arduino-api-doc
branch
2 times, most recently
from
982677b to
7676c2f
Compare
| #. Complete the core setup by linking the API folder from the ArduinoCore-API repository into | ||
| the arduinocore-zephyr folder: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| git clone https://github.com/arduino/ArduinoCore-API # Any location | ||
| cd /<path>/<to>/<zephyrproject>/modules/lib/arduinocore-zephyr | ||
| ln -s /<your>/<location>/arduinocore-zephyr/api cores/arduino/. |
There was a problem hiding this comment.
Is this supposed the be the "manual steps" mentioned in the previous bullet point? If yes it probably needs to be a sub-bullet or a .. note or something since otherwise it's not clear users who've run the install script can skip this
What's more, it's supposed to be instructions for non Linux users and yet it uses ln -s which won't be available to windows users?
There was a problem hiding this comment.
What's more, it's supposed to be instructions for non Linux users and yet it uses ln -s which won't be available to windows users
I haven't really tried using Arduino Core Zephyr on windows, I meant these steps for people with non standard paths/ environments. I will try to reword all of it to reduce ambiguity
There was a problem hiding this comment.
@kartben can you take a look at the note I added now, does it make sense?
Thanks for all the reviews so far!
There was a problem hiding this comment.
I recommend that you follow the getting started guide's method of providing platform-specific installation instruction tabs instead of this. The current approach feels kind of hacky by comparison and the infrastructure to do a better job is already there in the docs build system.
There was a problem hiding this comment.
As I said above too,
will update my docs according to zephyrproject-rtos/arduino-core-zephyr#139 now, we can just use a single west command and all this confusion should go away.
Thanks @soburi !
Add documentation for the Arduino Core API for zephyr which sits as an external module as of today. Signed-off-by: Dhruva Gole <[email protected]>
DhruvaG2000
force-pushed
the
arduino-api-doc
branch
from
7676c2f to
c8db58a
Compare
|
| =============================================== | ||
|
|
||
| #. To pull in the Arduino Core for Zephyr as a Zephyr module, either add it as | ||
| a West project in the west.yaml file or pull it in by adding a submanifest |
| #. To pull in the Arduino Core for Zephyr as a Zephyr module, either add it as | ||
| a West project in the west.yaml file or pull it in by adding a submanifest | ||
| (e.g. ``zephyr/submanifests/arduino-core.yaml``) file with the following content | ||
| and run west update: |
There was a problem hiding this comment.
This line duplicates the next step.
| #. Complete the core setup by linking the API folder from the ArduinoCore-API repository into | ||
| the arduinocore-zephyr folder: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| git clone https://github.com/arduino/ArduinoCore-API # Any location | ||
| cd /<path>/<to>/<zephyrproject>/modules/lib/arduinocore-zephyr | ||
| ln -s /<your>/<location>/arduinocore-zephyr/api cores/arduino/. |
There was a problem hiding this comment.
I recommend that you follow the getting started guide's method of providing platform-specific installation instruction tabs instead of this. The current approach feels kind of hacky by comparison and the infrastructure to do a better job is already there in the docs build system.
| Supported Boards | ||
| ================ | ||
|
|
||
| The Arduino Core API module currently has variants for these boards: |
There was a problem hiding this comment.
This is going to go stale. What is your maintenance plan?
There was a problem hiding this comment.
Hmm you're right, I might rather add a link to the variants folder of the module directly, that might make more sense @mbolivar ?
|
|
||
| #. Create a new folder in the ``variants/`` directory with your board's name | ||
| #. Add an overlay file and a pinmap header file that match the board name | ||
| #. Add your new headerfile to an ``#ifdef`` statement in the ``variant.h`` file |
6 participants
Add documentation for the Arduino Core API for zephyr which sits as an external module as of today.