Update Readme and FAQs

[tmhastings]

• Minor formatting correction in Readme.md
• Complete overhaul of FAQs, including new formatting with dropdowns. The last update to FAQs was 3 years ago.

[marionbarker]

Does it make sense to have FAQs here? That is one more file to keep in alignment with openiapsdocs.

[bjornoleh]

Does it make sense to have FAQs here? That is one more file to keep in alignment with openiapsdocs.

For me the FAQ can be deleted. It was created by ivalkou before any docs existed. If there is anything useful there, the contents can be copied to the docs (but only if it’s not already covered)

[dsut4392]

The good part about having the build information contained in README.md is that the information will align with the user’s repository version. If Readme.md uses an external link ti the build information it’s possible that the upstream beach will have been updated and the user’s repo is out of sync, resulting in build instructions that don’t work.

[marionbarker]

I was not clear in my earlier comment. I suggest removing the content that is not about building, i.e., history, compatible pumps and cgm, etc. and replace that with the reference to the docs.

The build instructions are not correct (missing the submodule recurse flags) and should be updated.

I think the readme in LoopWorkspace is a reasonable prototype for what needs to be here.

[marionbarker]

I recommend this PR be closed as out-of-date.

There are 3 files to be modified by the PR.

• FAQ.md
• README.md
• developer_contributions.md

The first two are in conflict and the versions in dev should be maintained.

• FAQ.md (and FAQ_RU.md) was removed from dev branch
• README.md was modified for Trio in dev branch

If the developer_contributions.md file is desired, I think it should be completed and then added with a new PR.

[MikePlante1]

Closing due to staleness. Please reopen later if needed.