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

Documentation needed for New C/C++ Project options #151

Open
eparadis opened this issue Jan 10, 2025 · 0 comments
Open

Documentation needed for New C/C++ Project options #151

eparadis opened this issue Jan 10, 2025 · 0 comments

Comments

@eparadis
Copy link

Describe the bug
When creating a new project using the "New C/C++ Project" quick action, it is unclear what any of the selectable options do.

To Reproduce
Steps to reproduce the behavior:

  1. Install the latest version of the extension following the documentation here.
  2. Click 'New C/C++ Project' from the extensions quick actions menu
  3. Enter a project name
  4. Scroll down to the 'Features', 'Stdio support', 'Code generation options', and 'Debugger' sections

Expected behavior

  • Each of these selectable options has a description available which describes what they are.
  • The reason you would want to choose any option is briefly explained. (IE: "Running the program from RAM rather than flash will foobar your dingbats more frumiously.")
  • Abbreviations are defined.
  • Any tradeoffs when selecting different combinations are explained. (IE: "By enabling the HW watchdog, you will have access to one less HW Timer.")
  • Whether or not you can change these options in the future is explained.
    • If they can be changed, how to do so is briefly explained. (IE: "These options can be changed later for this project by using the 'Change options...' menu item")

Actual Behavior

  • The user is presented with 15 binary choices (32k possible combinations)
  • The PDF documentation briefly explains the "Stdio support"

Platform (please complete the following information):

  • OS: MacOS
  • Architecture: arm/apple

Additional context
Please add this documentation inline to the extension itself. It should of course be added to the PDF documentation as well, but external documentation will quickly go out of date and the extension should be self-documenting.

I would offer to cut a PR to address this, but there doesn't actually seem to be any documentation of these options in the first place.

Unexplained options
(for future searching)

  • Features
    • SPI
    • I2C interface
    • UART
    • PIO interface
    • DMA support
    • HW interpolation
    • HW watchdog
    • HW timer
    • HW clocks
  • Stdio support
    • Console over UART
    • Console over USB (disables other USB use)
  • Code generation options
    • Run the program from RAM rather than flash
    • Use project name as entry point file name
    • Generate C++ code
    • Enable C++ RTTI (Uses more memory)
    • Enable C++ exceptions (Uses more memory)
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

1 participant