[docs] Add a Getting started doc.#14
Merged
AlexLanzano merged 1 commit intowolfSSL:mainfrom Mar 14, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a "Getting Started" guide for wolfHAL, explaining how to integrate the library into a bare-metal embedded project, along with a link to it from the main README.
Changes:
- Added
docs/getting_started.mdcovering project layout, device model, peripheral configuration, initialization, API usage, and size optimization strategies. - Added a link to the new guide in the "Further reading" section of
README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/getting_started.md | New getting started guide with code examples for wolfHAL integration |
| README.md | Added link to the new getting started guide in the further reading list |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.