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

Suggestions for minor improvements to the documentation #24

Open
NiklasRentzCAU opened this issue Mar 8, 2024 · 3 comments
Open

Suggestions for minor improvements to the documentation #24

NiklasRentzCAU opened this issue Mar 8, 2024 · 3 comments

Comments

@NiklasRentzCAU
Copy link
Contributor

While going through the documentation, I found some small issues that I do not know the exact answers to, so I wanted to leave them here for clarification before trying to fix these myself:

All in in 3. Tools and Environments:

  • the links to "Installation Instructions" and "Resources" lead to non-existent pages, where should they lead instead?
  • when using the nix setup, it seems to be necessary to follow the pico-examples readme first and install this:
sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib
  • in the "Using VS Code" section it might be good to and another hint that nix develop needs to be executed first in the lf-3pi repository first as well.
  • using screen may skip some outputs that are not shown on the computer's terminal. I don't know the exact reason why this is, but an explanation for that could help the reader.
@edwardalee
Copy link
Contributor

Thanks for the feedback! I've pushed a fix for the first and third bullet items.
For the second bullet item, I thought the template repo was supposed to include these tools automatically. Did you run
git submodule update --init? If that is not sufficient, where exactly would you suggest putting these instructions?
As for the fourth, I have not seen this phenomenon and have no insights on why it might be occurring, unfortunately...

Feel free to issue a pull request for any and all improvements that come to mind, and thanks for these!

@lhstrh
Copy link
Member

lhstrh commented Mar 10, 2024

For the second bullet item, I thought the template repo was supposed to include these tools automatically.

Only if your in a nix-configured shell (i.e., after running nix develop). Maybe @NiklasRentzCAU was operating in a "normal" shell?

@NiklasRentzCAU
Copy link
Contributor Author

When opening VS Code in the required folder I first did not find the "gcc-arm-none-eabi" until after doing this manual installation. I did do git submodule update --init first, but its possible that I did not have a nix-configured shell up at that moment. I cannot re-test it now as after this installation it now works.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants