Documentation: Add quickstart guide to the yaml

[sils]

The docs give an intro to the command line and then immediately talk about inheritance of yamls without introducing them or the most important keys first, I think that'd help me and others a lot.

[chfw]

Your feedback is appreciated. I will write down more docs. Stay tuned. I will request your review on my docs commit.

[chfw]

instead of putting you on wait, here is a brief info:

moban itself has requirements on the keys in the yaml file. The principle: keys in yaml file serve the data dict, with which jinja2 renders the templates. So, the keys are buried and scattered inside the templates. No reference in templates, No keys.

The keys in yaml file become compulsory when templates uses them. As of now, pypi-mobans are the default templates for python packages, hence it does require compulsory keys so it would function. And I should outline them for reference. But if we step back once, if you do not use pypi-mobans, you are not obliged to declare the keywords. And if you write your own templates(mobans), such as "My first {{thing}}", you may want to put thing in your yaml file.

Why would one need to override? The use case: in an organisation, there are more than one repo and all of them share similar texts: organisation, mission, but differ in details: such as author, description, version, copyright. So in the default yaml file, the organisation may want to put all initial values and each repo can override the default yaml file.

[PrajwalM2212]

@sils Thanks for requesting this.
@chfw Thanks for explaining this in the comment. I too think that more documentation would surely benefit anybody viewing the project.