Minor comments on the README

robotology / superquadric-grasp-demo

Object modeling and grasping with superquadrics and visual-servoing

GNU General Public License v2.0

3 stars 4 forks source link

Minor comments on the README #1

Closed pattacini closed 7 years ago

pattacini commented 7 years ago

@giuliavezzani well done with the README!

I've got a couple of suggestions though, which you might be already considering:

It'd be quite important to expose more information on the visual-servoing; perhaps @claudiofantacci can help on this.
Linking the video could make the documentation even more appealing 😄

giuliavezzani commented 7 years ago

Ok, I'll improve it asap :smile:

giuliavezzani commented 7 years ago

A comment on what @pattacini suggested. I have already provided a more detail description of the visual-servoing in the README.md of the superquadric-grasp module. Should I link to this section in the icub-grasp-demo or should I "copy&paste" it also in the icub-grasp-demo README.md? While writing the README.md, I followed this standard: in the icub-grasp-demo I only provide high-level information. The information strictly related to one module is in the relative repository.

pattacini commented 7 years ago

Ok then, no need to expand on the tools behind any further 👍

Just make sure that you clearly state to refer to the documentation of the single modules somewhere and, yes, put a slight emphasis here in on the fact that we're using visual-servoing too (a couple of lines are enough). I had a quick glance at the README yesterday and didn't catch it.

Thanks!

giuliavezzani commented 7 years ago

Yes, I definitively have to stress the point that visual servoing is used in the demo and where is the relative information. :+1: