CiscoDevNet / csmp-agent-lib

CiscoDevNet Opensource CSMP-Agent Library (OpenCSMP)
https://github.com/CiscoDevNet/csmp-agent-lib
Apache License 2.0
4 stars 3 forks source link

Implement FreeRTOS on Linux OSAL port #17

Closed ismilak closed 1 month ago

ismilak commented 2 months ago

Implementing FreeRTOS linux port for OSAL.

ismilak commented 2 months ago

Please review the markdown file update too. I updated the md file with minimal OSAL multi-target and FreeRTOS build process information. @manojnacsl what is the required/used tool to generate pdf from markdown to have the same format?

manojnacsl commented 1 month ago

Please review the markdown file update too. I updated the md file with minimal OSAL multi-target and FreeRTOS build process information. @manojnacsl what is the required/used tool to generate pdf from markdown to have the same format?

@ismilak - We have been updating the README.md file using the Github's in-built editor, available within Github portal. A separate Developer's guide is maintained (docs/CSMP Developer Tutorial - 0v11.pdf) which is regularly updated and exported to pdf for sharing with the community. There are external tools viz., md2pdf, pandoc, markdown-pdf and others which could be used for conversion.

ismilak commented 1 month ago

Please review the markdown file update too. I updated the md file with minimal OSAL multi-target and FreeRTOS build process information. @manojnacsl what is the required/used tool to generate pdf from markdown to have the same format?

@ismilak - We have been updating the README.md file using the Github's in-built editor, available within Github portal. A separate Developer's guide is maintained (docs/CSMP Developer Tutorial - 0v11.pdf) which is regularly updated and exported to pdf for sharing with the community. There are external tools viz., md2pdf, pandoc, markdown-pdf and others which could be used for conversion.

I fixed a typo in the readme and generated the pdf version of readme.md. Developer guide source is not available in the repository to modify the documentation. How can we update the Developer guide? Should we create a new one for new targets? Anyway I think we should update dev guide when efr32 target will be introduced. FreeRTOS on Linux is the same runtime environment, there isn't any complicated step to execute the FreeRTOS binary, so I think mentioning in the current dev guide is not necessary. What do you think?

paduffy commented 1 month ago

I’ll review and update the developer guide once the Silabs PRs are settled.

Cheers

From: Manojna CSL @.> Sent: Thursday, May 30, 2024 1:15 AM To: CiscoDevNet/csmp-agent-lib @.> Cc: Paul Duffy (paduffy) @.>; Assign @.> Subject: Re: [CiscoDevNet/csmp-agent-lib] Implement FreeRTOS on Linux OSAL port (PR #17)

Please review the markdown file update too. I updated the md file with minimal OSAL multi-target and FreeRTOS build process information. @manojnacslhttps://github.com/manojnacsl what is the required/used tool to generate pdf from markdown to have the same format?

@ismilakhttps://github.com/ismilak - We have been updating the README.md file using the Github's in-built editor, available within Github portal. A separate Developer's guide is maintained (docs/CSMP Developer Tutorial - 0v11.pdf) which is regularly updated and exported to pdf for sharing with the community.

— Reply to this email directly, view it on GitHubhttps://github.com/CiscoDevNet/csmp-agent-lib/pull/17#issuecomment-2138697109, or unsubscribehttps://github.com/notifications/unsubscribe-auth/BHXULF655UDWTYYHJEYK6QTZE2YVTAVCNFSM6AAAAABH3Y6FMWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZYGY4TOMJQHE. You are receiving this because you were assigned.Message ID: @.**@.>>

manojnacsl commented 1 month ago

Please review the markdown file update too. I updated the md file with minimal OSAL multi-target and FreeRTOS build process information. @manojnacsl what is the required/used tool to generate pdf from markdown to have the same format?

@ismilak - We have been updating the README.md file using the Github's in-built editor, available within Github portal. A separate Developer's guide is maintained (docs/CSMP Developer Tutorial - 0v11.pdf) which is regularly updated and exported to pdf for sharing with the community. There are external tools viz., md2pdf, pandoc, markdown-pdf and others which could be used for conversion.

I fixed a typo in the readme and generated the pdf version of readme.md. Developer guide source is not available in the repository to modify the documentation. How can we update the Developer guide? Should we create a new one for new targets? Anyway I think we should update dev guide when efr32 target will be introduced. FreeRTOS on Linux is the same runtime environment, there isn't any complicated step to execute the FreeRTOS binary, so I think mentioning in the current dev guide is not necessary. What do you think?

@ismilak - It would be good to have one Developer's guide for all targets. @paduffy has confirmed he will review and update the Dev guide once all the ongoing FreeRTOS changes are concluded/committed.