AtomVM icon indicating copy to clipboard operation
AtomVM copied to clipboard

Documentation: Missing `cd` in STM32 Build Instructions

Open c-alpha opened this issue 2 months ago • 2 comments

This set of STM32 build instructions

https://github.com/atomvm/AtomVM/blob/0f4a060551a961c333d69f5f46d99ac9344e9463/doc/src/build-instructions.md?plain=1#L762-L767

seems to be missing a

$ cd src/platforms/stm32

at the start (i.e. insert as a new line after 762)?

c-alpha avatar Nov 09 '25 16:11 c-alpha

Thank you for opening this issue. We do want to make sure the documentation is clear and easy to follow. I guess it should have been more explicit, but the step above does say starting “from inside the AtomVM/src/platforms/stm32 directory:”

UncleGrumpy avatar Nov 09 '25 17:11 UncleGrumpy

Thank you for opening this issue. We do want to make sure the documentation is clear and easy to follow. I guess it should have been more explicit, but the step above does say starting “from inside the AtomVM/src/platforms/stm32 directory:”

While that is certainly the case, the examples for all other platforms in this file do include the cd command.

Hence, in the spirit of "mixed style is worse than bad style", I would welcome either removing the cd commands from all other examples, or adding the cd command in this single case.

c-alpha avatar Nov 10 '25 12:11 c-alpha