Reference links in generated project

Related to #279

After a quite involved brainstorming with @bclozel we came to the conclusion that rendering links in the front page is the wrong call. There are a lot of information on this page already and the prototypes that we’ve built clearly show that it does not help at all.

Our reasoning is that we must support our goal to let users work in their IDE as soon as possible and not forcing them to stay on the page to collect URLs. We believe that generating a markdown/asciidoc at the root of the project with some information would be quite interesting. As a first iteration we could render the links, if any.

I am not sure that we want to call that README.md and it should probably be in the .gitignore for the time being. Maybe HELP.md ?

[wilkinsona]

The reasoning why it’s not named README is because I don’t think this is something that a user should commit to its own repo

I think people might want to commit it. Having links to the documentation/guide for each thing that’s being used could be useful for people joining a new team, for example.

I am in favour of it being README.

I am with you on the .adoc vs. .md. We need to chose whatever format is natively recognized in the IDE.

Another +1 for Markdown.

[snicoll]

Let’s go with README.MD