README Clarification

[damianoneill]

I am unclear what is happening in each of the sections. Everything with a section header requires an explanation of what it’s doing when running the commands. This will require someone who understand this to complete, I can’t help with this.

For e.g. thing that should be described;

• When I run ‘make generate’ what is being generated? Why are we generating? How will they be used?
• What are the schema files, how are they used?
• When I run ‘make test’ what is being tested, the generator, framework, use cases, etc?
• What is the API server, when I start it what is it exposing? How can I confirm it started correctly? What endpoints are available?
• The two command line tools that are shown, how are these built?

[damianoneill]

@nati the commit doesn't address all the issue above. I need textual descriptions in each of the sections for the Bullets listed above.

The problem is although I can execute each of the commands I dont understand why I am doing this or what happens when I do it.

For others who are not familiar with the code (myself included) we need to describe what this provides.

Does this make sense?

[nati]

Oh I thought the PR answered your questions because you approved it. I believe I've updated README to answer your questions, so if current description isn't enough clear could you clarify your questions again?

[damianoneill]

Sure @nati

The bullet points above, I'm looking for textual answers in each section. If it's easier maybe we could do a webex and you could walk me through the code, based on that I'll write up the descriptions? If this is an option, I'd like to extend the invite to others in the METc team?

Thanks, Damian.