make goals visible in README.rst

[sleep-walker]

make primary goals visible in README.rst (as discussed during meeting)

[marcus-h]

On 2017-05-27 03:09:51 -0700, Tomáš Čech wrote:

make primary goals visible in README.rst (as discussed during meeting)

Thanks for the PR! Some minor comments below.

+Reason why osc2 was created is that experience with osc is less

"the" experience?

+than stellar. To create new improved tool we set these goals:

Maybe simply "Goals:"?

+ +- provide consistent invocation and behavior for all commands +- split the code into smaller pieces so it is easier to maintain and extend

Maybe simply "- modular code"?

+- strictly separate command line interface from the main code and code generating output;

Hmm maybe simply "MVC based approach"?

provide module so the functionality is available for other scripts

Hmm what do you exactly mean?

+- use reasonable return codes, return non-zero code in case of failure +

Hmm I only partly agree here. In some cases exceptions make more sense than return codes (and, of course, vice-versa).

Btw., these goals are quite generic and probably most devs have them in mind when writing code/software (actually, most of the goals are IMHO "common sense")

[sleep-walker]

Hi Marcus, thanks for your comments.

provide module so the functionality is available for other scripts

Hmm what do you exactly mean?

That other python tools can import osc2 as module.

Btw., these goals are quite generic and probably most devs have them in mind when writing code/software (actually, most of the goals are IMHO "common sense")

They are generic and 'common sense'. Yet neither of these goals is met with osc and so they are expressed reasons to do osc2 better.