Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Tweak the examples directory to make dart::gui::osg more accessible #1304

Closed
mxgrey opened this issue May 3, 2019 · 2 comments · Fixed by #1305
Closed

Proposal: Tweak the examples directory to make dart::gui::osg more accessible #1304

mxgrey opened this issue May 3, 2019 · 2 comments · Fixed by #1305
Assignees

Comments

@mxgrey
Copy link
Member

mxgrey commented May 3, 2019

Many new users will go to the dart/examples directory to get started with writing an application, but if they click randomly (which many are likely to do), odds are they'll select one of the old glut-based examples instead of one of the newer osg-based examples.

I would propose changing the directory layout to something like

examples
|-- glut_examples_(deprecated)
|   |-- addDeleteSkels
|   |-- atlasSimbicon
|   |-- ...
|-- osg_examples_(recommended)
    |-- osgAtlasPuppet
    |-- osgAtlasSimbicon
    |-- ...

We may also want to make sure that all the old glut-based examples have been ported over to osg. If we can put ourselves in a position where people only expect support for OSG instead of both OSG and glut, it might make it easier to address questions.

@mxgrey mxgrey self-assigned this May 3, 2019
@jslee02
Copy link
Member

jslee02 commented May 3, 2019

I like this idea. One thing I'd like to add is changing the name of directories (so the executable names as well). As the intention is to imply the OSG is the recommended renderer, I would remove the osg prefix from the OSG examples and add glut prefix to GLUT examples. So the structure would be like:

examples
|-- glut_examples_deprecated
|   |-- glutAddDeleteSkels
|   |-- glutAtlasSimbicon
|   |-- ...
|-- osg_examples
    |-- atlasPuppet
    |-- atlasSimbicon
    |-- ...

or

examples
|-- deprecated
|   |-- glutAddDeleteSkels
|   |-- glutAtlasSimbicon
|   |-- ...
|-- atlasPuppet
|-- atlasSimbicon
|-- ...

Also, I would like to be consistent in the directory name case pattern to be either of all lower cases or Pascal style. I know we've been using Pascal style, but I'm slightly inclined to lower cases since it seems to be more widely used.

@mxgrey
Copy link
Member Author

mxgrey commented May 3, 2019

That all sounds good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants