Please expand the README.md

[pvalena]

Please, at least add quick howto like Install (or links to it). And/Or a short example for usage (not a big block of text like there is).

This is quite usual (and welcoming) for upstream projects to have this in the README.md :).

[BDFL669]

I'd be happy to help with this issue. Please assign it to me

[pvalena]

Glad to hear that! Please wait for the repo maintainers/owners to agree some changes are needed :).

[BDFL669]

Ok, thank you.

…

On Mon, 4 Mar 2024, 20:54 Pavel Valena, ***@***.***> wrote: Glad to hear that! Please wait for the repo maintainers/owners to agree some changes are needed :). — Reply to this email directly, view it on GitHub <#2730 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AOZBHUVNRCL6IRI5AZYHRD3YWSYPDAVCNFSM6AAAAABEFSCQQ2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNZXGE2TANRUG4> . You are receiving this because you commented.Message ID: ***@***.***>

[LecrisUT]

Worth considering:

• Move the README content into docs/overview #2414 The contents of the README were moved recently to better support sphinx-specific decorators. But having a more shortened tl;dr version of that as a front-page is worth reconsidering
• synchronization of README.md with index.md (example, see usage of <!-- SPHINX-START -->)
• Badges? Many cool ones from https://shields.io/badges
• What to include? Best discussed with the main developers, but some things I think would be nice
  • Purpose and goal of tmt. I view it as a tool to unify testing independent of CI environment
  • One simple test.fmf with the cli interface to trigger/CI environments that run it
  • Where to get in touch
  • Primary sponsors?

Anyway let's wait for more feedback from @lukaszachy @psss @thrix? Happy to review though.

[psss]

Yes, the original README content was moved because it has grown substantially and it did not make sense to maintain similar information on several places. I like the idea of providing a tldr version on the most essential commands. Perhaps, we could resolve this issue together with this one?

• Create a tldr version of the tmt man page #968

The same content could be submitted to the tldr command repository. Plus, in the README we could include a link to the installation instructions to help users get quickly started?