Expand the readme

[jontje]

Add sections for:

• Structure/class descriptions
• Troubleshooting
• Acknowledgements

[gavanderhoorn]

See my comment here: ros-industrial/abb_libegm#17 (comment).

[jontje]

That sounds reasonable, see my reply here ros-industrial/abb_libegm#17 (comment).

Except that the "structure/class descriptions" would be something like this for RWS:

• Add a simple illustration of how the important classes are related to each other.
• Add some very brief lines for each class. For example:
  • POCOClient
    Sets up, and manages a HTTP client and (if needed) a WebSocket instance (based on POCO classes)
  • RWSClient
    Expands the POCOClient for using RWS (e.g. exposing RWS services and resources, evaluating the communication results)
  • RWSInterface
    Provide more user friendly APIs (e.g. wraps a RWSClient and provide simpler methods)
  • RWSStateMachineInterface
    Extends the RWSInterface for a system specific case (i.e. requires specific configurations and RAPID program running on the robot controller)

This just so that one can get a quick overview, without digging into the details.

[jontje]

Regarding troubleshooting:
The readme should be update to include a description of the problem mentioned in issue #47 and the possible solution in comment #47 (comment)

[gavanderhoorn]

Regarding troubleshooting:
The readme should be update to include a description of the problem mentioned in issue #47 and the possible solution in comment #47 (comment)

Tracking this outstanding task in #81 (which I believe is a nicer solution than the proxy approach described in #47 (comment)).

[gavanderhoorn]

Closing, as I believe all the other additions to the readme have been made.

Further improvements can be suggested/tracked in other issues.

Thanks @jontje 👍