search

roboticslab-uc3m / questions-and-answers

A place for general debate and question&answer
https://robots.uc3m.es/developer-manual/appendix/repository-index.html
2 stars 0 forks source link

How should I document my project's dependencies? #14

Closed David-Estevez closed 2 years ago

David-Estevez commented 7 years ago

I am currently documenting the dependencies of the textiles project and I haven't been able to find any instructions about how to document a project within the RoboticsLab organization.

Textiles is a large project mixing C++ and Python, using non-stable package versions for some dependencies in order to get state of the art methods not available in stable releases.

As no other project depends on it (yet)... should I include my dependencies / instructions in my repo only? should I use whatever method has been chosen for the main repos of this organization? where can I find that method?

jgvictores commented 6 years ago

Along this topic, a nice table developed by @David-Estevez can be found here.

PeterBowman commented 2 years ago

@jgvictores any follow-up?

jgvictores commented 2 years ago

@jgvictores any follow-up?

I'm happy with how we currently document dependencies, see any example: https://github.com/roboticslab-uc3m/yarp-devices/blob/e3e45205ba11a9c3ab9ac5beebdac74b22f1d515/doc/yarp-devices-install.md#installation-from-source-code

jgvictores commented 2 years ago

PS: Also see a more complex case: https://github.com/roboticslab-uc3m/openrave-yarp-plugins/blob/99389db08da34594e3de54490036c4caa68e967d/doc/openrave-yarp-plugins-install.md#openrave-yarp-plugins-installation-from-source-code

PeterBowman commented 2 years ago

Thanks! I'm closing, then.