[feature] Custom Readme for a Recipe

[FreePhoenix888]

What is your suggestion?

I have met such a problem that imgui's recipe documentation shows me a few lines that I should have in my conanfile.txt and CMakeLists.txt but actually I need a lot more things to do in these files. An author should have ability to have custom readme (as in npm) to tell such things

Have you read the CONTRIBUTING guide?

• I've read the CONTRIBUTING guide

[FreePhoenix888]

Related: conan-io/examples#118 (comment)

[memsharded]

Thanks for your suggestion @FreePhoenix888
Quick question: You mean in the web site https://conan.io/center for packages?

[FreePhoenix888]

Thanks for your suggestion @FreePhoenix888 Quick question: You mean in the web site https://conan.io/center for packages?

Yes. Here https://conan.io/center/recipes/imgui?version=cci.20230105%2B1.89.2.docking is only standart info but actually a lot more is required to setup imgui library, does author has ability to have custom readme

For example zlib in npm has ability to have its own readme to provide more information to users: https://www.npmjs.com/package/zlib

[memsharded]

Transferred to the web repo, this wouldn't be a Conan client feature

[FreePhoenix888]

Transferred to the web repo, this wouldn't be a Conan client feature

You are right, I should created this in web repo. Just missed it :)

[FreePhoenix888]

Update: this also could be usable for conan client too, as npm:

npm view lodash readme

[prince-chrismc]

FWIW vcpkg has this feature, ports can have thier own readme and the community site actuallysupports it ;)

especially for projects that need extra setup (picking backends) this would be awesome.