RFC: Managed Readme file

What do you think about introducing a construct for a README.md. Not the existing SampleFIle but a projen managed one.

Many projects could benefit from some opinionated defaults.

I think of a list of badges that are auto-generated, installation instructions depending on project type, license info, link to CHANGELOG.md and API.md, etc.

The main part would still be custom text that the repo owner has to provide.

[hoegertn]

I am thinking about not putting the README into the project options (there are soo many) but have a ReadmeConstruct that gets initialized with a project and its own props.

new Readme(project, {
  toc: true,
  codeOfConduct: true,
  additionalBadges: [
    'some bagde snippet'
  ],
  ...
});

Additionally: project.addReadme(props);

A lot of the content could be automagically be derived.

EDIT: OTOH maybe only readme: true and then configure the rest on a readme object

[pgollucci]

I added Roadmap and Vision below. We can definitely add install ins too. This would help a log for construct-catalog.