New user documentation

[glelouet]

• README.md
• docs/contributing.md
• docs/extending.md
• docs/overview.md
• docs/starting.md

initial :

@phax please make a pass to check if that is clear. The goal is to help other people, not make them more confused :D

[phax]

Looks fine to me. Do you want to add something on top of it?
Shall we add a statement on different Java versions, to use Maven profiles (I know I need to check the switch expression pr...)

[glelouet]

I think you're right, each feature should be documented. That would go in a dedicated doc/ folder though. Or docs / ? Or keep them at root / with .md to know they are doc ? I rather have them in dedicated folder, even though it makes links more awkard (starting with ../ )
Anyhow I rather have the root README.md cleaner with only simplest, most important things, but I agree that a nice doc goes a long way in helping people use a library more useful.

Now I don't think we should doc each feature about code, as those are better kept up-to-date with tests.
However I think a few features could be made tests for in the new jcodemodel-tests module since that contains both the generating code, and the generated resulting classes.

I made it a draft and will think about it once you give your opinion about the location, and the creation of additional test/example classes. Should I make an issue ? This way we can list what we want.

[glelouet]

No answer, I put the doc in /documentation/ dir, with one contribution.md

[phax]

Super - sounds good :-) Thanks for your efforts

[phax]

Usually, I call the order docs but that really doesn't matter. So fine for me

[glelouet]

No, we use docs. No point in being confused, I personally don't care. And I also usually go with docs/ .

[glelouet]

@phax can you check the two md files ? starting is for people willing to use jcm, contributing is for people willing to help .

Note that I also changed the root readme.

[phax]

Sounds all fine for me - ready to merge?

[glelouet]

I need to add part on using the plugins (in using.md) .

edit : plus a part on the general architecture (overview.md) alongside the scripts present, and a part on how to produce new generators (extending.md).

[glelouet]

@phax I added tasks at the top. Can you check that you can tick the README ; then check if README changes are correct, untick it if not ?

I made a second pass on starting. If you think it's good, tick it please.