search

xmos / xcore_iot

Other
29 stars 39 forks source link

Build system example doesn't include the SDK #504

Closed xhuw closed 1 year ago

xhuw commented 1 year ago

Describe the documentation issue

Just reading the SDK documentation, spotted this page.

Those CMakeLists examples never include the SDK, so it won't exist when the SDK is added. I would expect to see a call to include/add_subdirectory/find_package/externalproject_add so that the SDK libraries being linked in will exist.

Further to this it would be good to show where the SDK should exist on a users system. Submodule of the project? installed in a single location for the user?

Other information

xmos-jmccarthy commented 1 year ago

In the past there has been much debate on whether people should develop their application inside or outside of the SDK. Due to this we are intentionally not prescriptive inside this repository, because it is up to the application developer to decide if they want to put their application inside the xcore_sdk repository or outside of the xcore_sdk repository.

The expected entry point for most users is at the sln_* level, not the xcore_sdk repository itself, which should provide more clarity. See https://github.com/xmos/sln_voice, in particular https://github.com/xmos/sln_voice/blob/develop/CMakeLists.txt

That all being said, I have updated the doc page referenced here to include that the repository is compatible with add_subdirectory(). PR #506

xhuw commented 1 year ago

Thanks for the thorough response. Update to the page looks good. I agree it's good to let the user chose how to use the SDK.