OpenAMP / open-amp

The main OpenAMP library implementing RPMSG, Virtio, and Remoteproc for RTOS etc
https://www.openampproject.org/
Other
706 stars 288 forks source link

readme: Fix broken openamp-rp mailing list link #460

Closed hiagofranco closed 1 year ago

hiagofranco commented 1 year ago

Fix broken link that gives "page not found".

Signed-off-by: Hiago De Franco hiagofranco@gmail.com

hiagofranco commented 1 year ago

Hi @arnopo, sure, I would like to improve the documentation in general. Should I use the mailing lists instead?

I'm still struggling to compile libmetal for my iMX7 cortex-M4, as soon as I understand everything, I believe it will be possible to help with the docs. Thanks!

arnopo commented 1 year ago

Hi @arnopo, sure, I would like to improve the documentation in general. Should I use the mailing lists instead?

Yes, the documentation is quite old and needs some refresh. FYI, some works have already started to restructure the documentation with sphinx in https://github.com/OpenAMP/openamp-docs. You are welcome if you want to help/contribute.

To contribute, the best way is to send pull requests. Anyway feel free also to send a message to the mailing if you want to have discussion on the documentation ( by mail or by participating to meetings)

I'm still struggling to compile libmetal for my iMX7 cortex-M4, as soon as I understand everything, I believe it will be possible to help with the docs. Thanks!

To build the libmetal the simple way is to create your own cmake configuration inspired from https://github.com/OpenAMP/libmetal/blob/main/cmake/platforms/zynqmp-r5-generic.cmake then If you're blocked there is a Q&A in libmetal to ask for help

hiagofranco commented 1 year ago

Thanks for the information @arnopo!

I'll try with the following link and if I have any questions I'll reach out through the mailing list.

Yes, the documentation is quite old and needs some refresh. FYI, some works have already started to restructure the documentation with sphinx in https://github.com/OpenAMP/openamp-docs. You are welcome if you want to help/contribute.

Got it! Thank you!

I've sent a PR to libmetal: https://github.com/OpenAMP/libmetal/pull/229