Created development setup script (including docs) #9
Conversation
Signed-off-by: jaenrig-ifx <[email protected]>
docs/development-instructions.rst
Outdated
|
|
||
| 5. Change directories:: | ||
| Ramya: I think we can skip this one, as the contributors should start with the .json package index installation available or? |
There was a problem hiding this comment.
Yes we can skip this. I mainly added this step for us. But not needed anymore. We should start with package index installation.
There was a problem hiding this comment.
Perfect. Technically, we could even have a script that also take cares of all these steps. Like quick-start-dev: Installing arduino-cli if not available, check the path is the default installation path, then clone the repo in the right... then run the git submodules + sym links.
But that would be maybe a improvement for later or?
| cd packages/Infineon-psoc/hardware/psoc | ||
|
|
||
| .. | ||
| TODO: We already have the "Infineon" package (from XMC-for-Arduino). We should go for "infineon" instead of "infineon-psoc". And |
There was a problem hiding this comment.
Yes I was also thinking that. But the problem is when both xmc and psoc needs to be installed, we should check if the package index json will get replaced or extended.
There was a problem hiding this comment.
Yes, we have to check that. Arduino has cores in different repos (and they all end up under /packages/arduino, but I think only one json file. I guess it should work if splitted in different jsons?
Easy to check anyhow :)
There was a problem hiding this comment.
Yes I am preparing a new release and once we have it we can check this
docs/development-instructions.rst
Outdated
|
|
||
| cd packages/Infineon-psoc/hardware/psoc/<x.y.z> | ||
|
|
||
| 5. Change directories |
There was a problem hiding this comment.
why the step number 3 and 4 missing?
docs/development-instructions.rst
Outdated
|
|
||
| cd cores/psoc | ||
|
|
||
| 6. Copy or symlink the ``api`` folder from the ArduinoCore-API submodule |
There was a problem hiding this comment.
Should we add another manual step before this symlinking point to checkout the arduino-core-api inside the extras folder? or Is it done with submodule init command (Is this done automatically or manually)?
| @@ -17,7 +19,7 @@ Paste the following URL into the *Additional boards manager URLs* input field un | |||
|
|
|||
| :: | |||
|
|
|||
| https://github.com/Infineon/arduino-core-psoc/releases/latest/download/package_infineon_index.json | |||
| https://github.com/Infineon/arduino-core-psoc/releases/latest/download/package_psoc_index.json | |||
There was a problem hiding this comment.
Do we want to rename this package_infineon_index to package_psoc_index?
There was a problem hiding this comment.
I think we cannot have the same name for both xmc-for-arduino and arduino-core-psoc... But I am not sure.
So i would say we name it only as psoc, and maybe at one point the other is named after xmc or?
There was a problem hiding this comment.
Yes we can try that
|
|
||
| cd packages/Infineon-psoc/hardware/psoc/0.0.1 | ||
| 0. Obviously |:neutral_face:|, install `Arduino IDE (2.0 or higher) <https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/>`_ or `Arduino CLI (1.0.0 or higher) <https://arduino.github.io/arduino-cli/0.24/installation/>`_. |
There was a problem hiding this comment.
An empty line between 0 and 1 would look good. But not sure if this will appear in the readthedocs page. There is an empty line between 7 and 8 but is not showing in the page.
There was a problem hiding this comment.
I believe that is because of the comments I inserted there, but we will remove some of them, as we get all those things clear.
jaenrig-ifx
force-pushed
the
api-setup
branch
4 times, most recently
from
64ef407
to
d83d9e9
Compare
Signed-off-by: jaenrig-ifx <[email protected]>
Signed-off-by: jaenrig-ifx <[email protected]>
…structions. Signed-off-by: jaenrig-ifx <[email protected]>
Signed-off-by: jaenrig-ifx <[email protected]>
jaenrig-ifx
force-pushed
the
api-setup
branch
from
d83d9e9
to
6bdb0c7
Compare
docs/development-instructions.rst
Outdated
|
|
||
| cd packages/Infineon-psoc/hardware/psoc/<x.y.z> | ||
|
|
||
| 3. 0. Initialize the ArduinoCore-API submodule |
There was a problem hiding this comment.
You have to just remove one "0." here :)
Signed-off-by: jaenrig-ifx <[email protected]>
By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---