<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<div dir="auto">Hi Robert,
<div dir="auto"><br>
</div>
<div dir="auto">My idea is that this could evolve into a large set of tutorials. Every header in the TOC would be a separate tutorial, responsible for teaching a osg concept. </div>
<div dir="auto"><br>
</div>
<div dir="auto">Each tutorial will have the one markup file containing the "lesson" and then the corresponding source code as separate files. The reason for including CMakeList files in every tutorial is to be able to do automatic testing. </div>
<div dir="auto"><br>
</div>
<div dir="auto">The main index.md.html will only be used as the table of contents. The index.html file is only used as a redirect, as Github pages won't accept .md.html files as a landing page. </div>
<div dir="auto"><br>
</div>
<div dir="auto">I took a quick look at readthedocs. Although it produces beautiful docs, it has one major drawback. It requires some setup and cannot easily be run for the client. Markdeep on the other hand is just a included Javascript file and can be viewed
instantly on every modern browser, without any additional setup. Which makes editing and additions simple for the community.</div>
<div dir="auto"><br>
</div>
<div dir="auto">Hopefully this explains my ideas a bit.</div>
<div dir="auto"><br>
</div>
<div dir="auto">Regards </div>
<div dir="auto">Björn </div>
</div>
<div class="gmail_extra"><br>
<div class="gmail_quote">Den 20 nov. 2017 12:13 skrev Robert Osfield <robert.osfield@gmail.com>:<br type="attribution">
<blockquote class="quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div><font size="2"><span style="font-size:10pt">
<div>Hi Björn,<br>
<br>
Thanks for your efforts on the tutorials. I had a quick look at what<br>
you have done so far, but am not yet clear how you are thinking it<br>
might evolve. I noticed both .md and .html files, are both something<br>
that will be maintained?<br>
<br>
On 19 November 2017 at 21:18, Björn Blissing <bjorn.blissing@vti.se> wrote:<br>
> * Is this a tutorial format worth pursuing?<br>
<br>
I quite like the idea of using github for tutorials, as it can easily<br>
be placed alongside the main OpenSceneGrpah repository and maintained<br>
in a pretty straight forward way. The format I don't yet have an<br>
strong opinions on though. Feedback from new members to the community<br>
who are currently learning would probably be really useful.<br>
<br>
> * Is Markdeep the right choice?<br>
<br>
Possibly.<br>
<br>
> * Is CCBY and MIT licenses that should be used for this project?<br>
<br>
For a tutorial I think it would be useful having a license that allows<br>
users to just grab source code and insert it directly into their<br>
applications without having to worry about attribution/including<br>
licensing. Would this be public domain? I'm not 100% sure.<br>
<br>
The documentation parts would naturally fall under creative commons.<br>
<br>
> * What C++ standard should the source code be written in (my suggestion is C++98 for maximum compatibility)?<br>
<br>
Unless one is demonstrating use with later versions of C++ I think it<br>
would be appropriate to leave it with CMake defaults like the OSG does<br>
at present.<br>
<br>
There is real value in having some C++11 and later tutorials as well.<br>
<br>
Robert.<br>
_______________________________________________<br>
osg-users mailing list<br>
osg-users@lists.openscenegraph.org<br>
<a href="http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org">http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org</a><br>
</div>
</span></font></div>
</blockquote>
</div>
<br>
</div>
</body>
</html>