Hi, As someone who as worked (on and off) with OSG for last 12 years I would like to share my opinion.
My principal belief is that splitting code and documentation (wiki) would inevitable lead to problems with keeping them in sync. Just look at the current tutorials which do not longer compile. So if the community would like to do something that would benefit new users of OSG, these would be my top two things to do: 1 - Write good examples that could serve as a step by step tutorial: These tutorial examples could be included into the source tree of OSG. By including them into the source tree we would have to keep them up to date with the latest source. The examples should be self contained and pretty much every line of code should have a comment explaining what and why we are doing things. To find topics for good tutorials the best thing to do would be to scan the mailing list archive for questions that keeps on coming back. (ex. how to use smart pointers, how to create your own geometry, how to update a scene, etc). Note: There is nothing wrong with the current examples, but they may often be to advanced for a beginner. 2 - Help with expanding the Doxygen generated documentation: When you have learned the basics most will try to experiment with the other functionality of OSG. So now you will start looking at the API-documentation. The problem you will encounter is either that the function as no documentation at all or that the documentation is very short and not very helpful. (In worst case it might even be deprecated and/or wrong). Robert can not be the only one writing API-documentation, we all need to pitch in. Regards, Björn ------------------ Read this topic online here: http://forum.openscenegraph.org/viewtopic.php?p=60874#60874 _______________________________________________ osg-users mailing list [email protected] http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org
