Move away from the monolithic README.md about pureconfig HOT 4 CLOSED

With our curent TOC, what do we want to move to the core module docs? There aren't includes in Markdown - that means some text will be a click away.

I was thinking of leaving the TOC as is and leave in the README all sections from "Why" to "Supported types" and from "Contribute" to "Special thanks". They provide the very basics for people to know what PureConfig is all about. All other sections can be accessed by the TOC, which links to other Markdown files.

@melrief, @jcazevedo, @leifwickland, do you agree?

from pureconfig.

I agree

from pureconfig.

@melrief, @jcazevedo, @leifwickland, do you agree?

Yes.

from pureconfig.

shrug
My preference in the long term is that we let tut or another tool generate our ToC. I'm not entirely sure how that'll work out with that structure. But that's a bridge we can cross later.

from pureconfig.