How to use

[aberba]

One thing that gets some of us to try and contribute is when we have a section on how to use a package in the README.

Import, basic examples, how to compile...tips🙏

That'll be handy

[aberba]

I love this initiative BTW...very excited you've started it 🙏

[hmmdyl]

@aberba I apologise for being offline as of recent, work is a bit hectic. I'm going to use this in my company for the next project so it will get some part time attention.

I'll write up a basic Readme tutorial and a wiki with tips, and more advanced tutorials in it. I'll leave this issue open until I complete it.

[hmmdyl]

I've partially done this. In README.md there is now an example usage section that shows how to compile LWDR and link it into your GCC C/C++ project for usage on an MCU. For reference, the example uses FreeRTOS (CMSIS compliant). I've included some light commenting on what the FreeRTOS functions do. I've also included the GDC compiler command.

You will need to compile GDC to target arm-none-eabi.

[hmmdyl]

I'll keep this open as I believe the documentation can be better.