Guide to showcase the quickest way to create a package based on a C program

[greenbreakfast]

Motivation

Why are we doing this? What use cases does it support? What problems does it solve? What is the expected outcome?

C programs are
This helps streamline the development process on the Omega2

Is your documentation request related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Onion recommends wrapping all custom code/applications into packages.
But there isn't a single source that can be followed from start to finish that explains how to create a package based on a C program

Describe the solution you'd like

A clear and concise description of what you want to happen.

A example-based, step by step guide that's easy to follow that shows me how to create a package based on a C program. It should mention the environment setup but ideally this should be very easy and quick.

I want to know:

• how to compile the package
• transfer the package to Omega
• Install the apckage
• Run the installed application

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

• for defining a package: working backwards from existing packages, and referencing the create a custom package article
• for compiling: following the how to compile a package article and trying to piece everything together

It would be ideal to have everything in one place, focusing on an example. Once I complete the example, I should be able to adapt it to my own application

[greenbreakfast]

Note for implementation: A new "Guides" section to the documentation will be added.
To publish the guide, please work in the content/guides branch on the guides/packages/c-package-example.md file

[remingtontr]

OKay. Tom Remington

…

________________________________ From: Lazar ***@***.***> Sent: October 31, 2024 8:44 AM To: OnionIoT/documentation ***@***.***> Cc: remingtontr ***@***.***>; Assign ***@***.***> Subject: Re: [OnionIoT/documentation] Guide to showcase the quickest way to create a package based on a C program (Issue #171) Note for implementation: A new "Guides" section to the documentation will be added. To publish the guide, please work in the content/guides branch on the guides/packages/c-package-example.md file — Reply to this email directly, view it on GitHub<#171 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A4B4PDPBY524VXODX3XTKWLZ6JF7NAVCNFSM6AAAAABQR6MZ4GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJQGIYDSNBRGQ>. You are receiving this because you were assigned.Message ID: ***@***.***>

[remingtontr]

Ready for initial review.

[remingtontr]

I have revised the article based on comments and new content in the outline file. Please review when you get the chance. Tom Remington

…

________________________________ From: Lazar ***@***.***> Sent: October 24, 2024 2:16 PM To: OnionIoT/documentation ***@***.***> Cc: remingtontr ***@***.***>; Assign ***@***.***> Subject: Re: [OnionIoT/documentation] Guide to showcase the quickest way to create a package based on a C program (Issue #171) Assigned #171<#171> to @remingtontr<https://github.com/remingtontr>. — Reply to this email directly, view it on GitHub<#171 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A4B4PDONJXO7UQAZK3XLRSLZ5FPSJAVCNFSM6AAAAABQR6MZ4GVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJUHA2TQOBYGA2DEOA>. You are receiving this because you were assigned.Message ID: ***@***.***>

[greenbreakfast]

@remingtontr thanks! added another round of comments and suggestions

[remingtontr]

Updated! Tom Remington

…

________________________________ From: Lazar ***@***.***> Sent: November 4, 2024 2:21 PM To: OnionIoT/documentation ***@***.***> Cc: remingtontr ***@***.***>; Mention ***@***.***> Subject: Re: [OnionIoT/documentation] Guide to showcase the quickest way to create a package based on a C program (Issue #171) @remingtontr<https://github.com/remingtontr> thanks! added another round of comments and suggestions — Reply to this email directly, view it on GitHub<#171 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A4B4PDIQTPHYCBDHW5XEUJLZ67QNDAVCNFSM6AAAAABQR6MZ4GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJVHAZDCNJVG4>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[remingtontr]

Updated. Tom Remington

…

________________________________ From: Lazar ***@***.***> Sent: November 4, 2024 2:21 PM To: OnionIoT/documentation ***@***.***> Cc: remingtontr ***@***.***>; Mention ***@***.***> Subject: Re: [OnionIoT/documentation] Guide to showcase the quickest way to create a package based on a C program (Issue #171) @remingtontr<https://github.com/remingtontr> thanks! added another round of comments and suggestions — Reply to this email directly, view it on GitHub<#171 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A4B4PDIQTPHYCBDHW5XEUJLZ67QNDAVCNFSM6AAAAABQR6MZ4GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJVHAZDCNJVG4>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[greenbreakfast]

@remingtontr Please go ahead with a PR. Let me know if you need any guidance on the windows steps for transferring the file.

[remingtontr]

Okay, so I added 171 directly to the contents/guides branch.

[remingtontr]

I got ahead of myself and committed changes for this on the content/guides branch directly rather than creating an Issue. My commit is under the #177 issue. Please let me know if you want me to back this out and create a separate PR.

[greenbreakfast]

@remingtontr yep, committing to the content/guides branch is ok. I made PR #177 so we can see it rendered.
I will take a closer look later this week and get back to you

[remingtontr]

Lazar, Sounds good! Tom Remington

…

________________________________ From: Lazar ***@***.***> Sent: November 12, 2024 11:35 AM To: OnionIoT/documentation ***@***.***> Cc: remingtontr ***@***.***>; Mention ***@***.***> Subject: Re: [OnionIoT/documentation] Guide to showcase the quickest way to create a package based on a C program (Issue #171) @remingtontr<https://github.com/remingtontr> yep, committing to the content/guides branch is ok. I made PR #177<#177> so we can see it rendered. I will take a closer look later this week and get back to you — Reply to this email directly, view it on GitHub<#171 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A4B4PDIAPBCO2S4ORVJ4K7L2AJJ7FAVCNFSM6AAAAABQR6MZ4GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINZRGQYDGNBXHE>. You are receiving this because you were mentioned.Message ID: ***@***.***>