Add debugging section to README

[vlucent]

Adds a debugging section with recommended NimBLE logging and observability settings to help diagnose connection and negotiation issues.

Feedback is welcome!

Related to #1159

Summary by CodeRabbit

• Documentation
  • Added a "Debugging" section with guidance on configuring debug options and a recommended debug configuration for connection and protocol diagnostics.

[coderabbitai]

📝 Walkthrough

Walkthrough

A new "Debugging" section is added to README.md pointing users to src/nimconfig.h for all NimBLE debug options, with instructions to uncomment/modify settings before compiling and a recommended MYNEWT_* macro configuration snippet for BLE connection/protocol logging.

Changes

Debugging Documentation

Layer / File(s)	Summary
Debugging section in README README.md	Adds a Debugging section documenting src/nimconfig.h as the home of all NimBLE debug options, with a recommended MYNEWT_* macro snippet for connection/protocol logging.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

Arr, a new section has sailed into port,
With MYNEWT_* macros of the debugging sort! 🏴‍☠️
Uncomment yer flags before ye compile,
And debug yer BLE in proper pirate style!
Yarrr, the README grows richer by the day,
No more lost sailors on the NimBLE way! ⚓

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Add debugging section to README' accurately reflects the main change: adding a new debugging section to the README documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}