v5.5.0 release prep

[shuchitak]

No description provided.

[xross]

Please can you do a few things for me to aid publication?

• add archive lib step: https://github.com/xmos/lib_xud/blob/1a25b64107302081e6ff4e8c76a92952ad2c0251/Jenkinsfile#L22
• make the clones shallow: https://github.com/xmos/lib_xud/blob/1a25b64107302081e6ff4e8c76a92952ad2c0251/Jenkinsfile#L5
• parameterise INFR_APPS_VERSION: https://github.com/xmos/lib_xud/blob/1a25b64107302081e6ff4e8c76a92952ad2c0251/Jenkinsfile#L49
• use buildDocs() from XJSL
• optionally add -DDEPS_CLONE_SHALLOW=TRUE to the example build. This is less important for libs (since we only zip up the lib, but it doesn't hurt)

There still seems to be a lot of stuff that needs tidying in this repo. Stuff I noticed:

• I think requirements.txt needs moving (as per other repos)
• index.rst in root of repo needs removing
• doc structure needs making standard (programming_guide/index.rst should be lib_mic_array.rst)
• (try and run lib_checks @ develop of infr apps as it will check settings.yml and readme)
• Add "Development repo" section to README
• I think the "script" directory should be "python" - according to other repos
• examples need renaming to app_
• is this cmake folder still needed? Its likely confusing for users
• delete .github/ISSUE_TEMPLATE
• delete doc/readme (we don't need to document building the docs in every repo..)
• I don't think the document titles are consistent
• Add references to figures

I'd like to sort out etc/vanilla and add it to the standard mic_array.h but that might have to wait for now

Sorry quite a bit!

[xross]

good catch

[xross]

Probably need to add something here with all the changes. The rename of examples at least.

[shuchitak]

done

[xross]

This doesnt match the Readme title

[xross]

Should be "PDM microphone array library"

[shuchitak]

Strange. I ran the xmos_settings_check.py and it was happy with the settings.yml. I thought what's in Doxyfile.inc PROJECT_BRIEF needs to match settings.yml (as prompted my xmos_settings_check.py). Didn't know that settings.yml needs to match README. Maybe xmos_settings_check.py needs to check for that as well?

[shuchitak]

I've changed the title to PDM microphone array library

[xross]

Yeah, test needs extending I guess. For new libs id like to make lib_template or similar.

[xross]

Thanks for your patience!