Addition of a supplementary documentation #49
Conversation
This file contains 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
… and data structures used by the library. Can be useful as a supplemental read apart from the main README.md for anyone new to using this library for their projects
|
Hello @ramakrishnan-gh , I am sorry for later response ... yes, your documentation update is very helpful for rpmsg-lite users. I would like to integrate it ... would it be possible to provide that in the markdown format to allow easy reading and integration into Github pages? Thank you. |
|
Hi @MichalPrincNXP , Thanks. |
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.
The intention of this PR is to make available documentation I made for myself as someone who is using this library newly for one of my clients. It tries to address some of the questions which I think anyone who is new to the library is likely to get when trying to understand the basic working of the library. It describes some of the basic data structures and methods that I think are helpful to understand.
The documentation can serve as a supplementary read to the main README.md. I'd request the owners to have a quick glance to see if this is something worthwhile to be in the upstream. I'll be happy to address review comments if that can make it better and be fit to be part of the upstream.