[osg-users] Call for assistance: Migrating and updating tutorials

Björn Blissing bjorn.blissing at vti.se
Mon Nov 20 02:34:36 PST 2017

As I said in my previous email. There is only one example tutorial right now. The first one in the basic category: "basic geometry"

The rest is as you say only a TOC.

I haven't checked readthedocs yet. It may be an option. But I like markdeep for its feature set.


Den 20 nov. 2017 09:00 skrev michael kapelko <kornerr at gmail.com>:
I can't see any tutorial. It's just a Table Of Contents. I guess at
least one tutorial is necessary to evaluate navigation.

As a side note, https://readthedocs.org/ hosts lots of docs with a
nice navigation, so this might be an option.

On 20 November 2017 at 00:18, Björn Blissing <bjorn.blissing at vti.se> wrote:
> Hi Robert et al,
> As said earlier, I have started to experiment with GitHub pages. I discovered that it was hard to support both single-page and multi-page documents using markdeep (since its limited support for included documents). So having a single-page and multi-page document at the same time will not work unless everything is in a completely flat directory structure, which will be unmaintainable. So I decided to go with a multi-page solution.
> I have pushed the current work to a personal repo on GitHub. You can checkout the result at:
> https://bjornblissing.github.io/openscenegraph-tutorials
> And the corresponding repo is here:
> https://github.com/bjornblissing/openscenegraph-tutorials
> So far I have built a test skeleton for tutorials. This includes a draft version of the table of contents and simple introduction tutorial to see if my test is working. I have included a CMakeList.txt file in the root directory which can be used to generate build files for the tutorials.
> The only available tutorial as of now is "Basic Geometry".
> But before I continue with any more work I would like some community feedback. There are many questions that I think should be answered:
> * Is this a tutorial format worth pursuing?
> * Is Markdeep the right choice?
> * Is CCBY and MIT licenses that should be used for this project?
> * What C++ standard should the source code be written in (my suggestion is C++98 for maximum compatibility)?
> Note: This should not be seen as anything more than a very rough draft of how tutorials on GitHub pages could look like. If the community agrees that this is the way forward I will continue the work, as well as transfer the repository to the main OpenSceneGraph GitHub account.
> Regards,
> Björn
> ------------------
> Read this topic online here:
> http://forum.openscenegraph.org/viewtopic.php?p=72416#72416
> _______________________________________________
> osg-users mailing list
> osg-users at lists.openscenegraph.org
> http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org
osg-users mailing list
osg-users at lists.openscenegraph.org

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openscenegraph.org/pipermail/osg-users-openscenegraph.org/attachments/20171120/fa138793/attachment.html>

More information about the osg-users mailing list