Improves README

[DiegoSanchezE]

Changes and Additions: Adds documentation on:

• the directory structure that the library creates.
• how the library generates the baseline, actual & diff images.
• what code needs to be deployed to successfully use the library.

Testing:

• Does it look good?
• Does it clarify the library's behavior?
• Is it too much?

Expected result:

• This helps the user understand how the library works/behaves.

[jessezach]

@DiegoSanchezE This looks good. The styling of keyword documentation can be improved maybe? I'm working on deprecating reportgen in the next release and implement a flask based server for reporting. User can then execute suite in test mode and moved all the images to baseline with a simple button click. Or Acceptable actual images can be made baseline with a button click. We may have to modify the ReadMe accordingly.

[DiegoSanchezE]

Sure thing, I'll improve the keyword styling and wait for your improvements before moving any further.

On Wed, Dec 5, 2018, 19:46 Jesse Zacharias <notifications@github.com wrote:

@DiegoSanchezE https://github.com/DiegoSanchezE This looks good. The styling of keyword documentation can be improved maybe? I'm working on deprecating reportgen in the next release and implement a flask based server for reporting. User can then execute suite in test mode and moved all the images to baseline with a simple button click. Or Acceptable actual images can be made baseline with a button click. We may have to modify the ReadMe accordingly.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/jz-jess/RobotEyes/pull/20#issuecomment-444738712, or mute the thread https://github.com/notifications/unsubscribe-auth/ATe4_rOjF9gi3EN2HAX3HPhi2rjvonfgks5u2JMmgaJpZM4ZFnZ_ .

[jessezach]

I haven't been able to find enough time to finish the server based report feature. I don't want to hold this PR because of that. Merging this to master