Plans for documentation and working demos

A place to discuss everything related to Newton Dynamics.

Moderators: Sascha Willems, walaber

Re: Plans for documentation and working demos

Postby JoshKlint » Sun Mar 07, 2021 11:04 am

I have had good results implementing my own system here (WIP):
https://www.ultraengine.com/learn

It parses markdown files stored on Github here:
https://github.com/Leadwerks/Documentation

For example:
https://github.com/Leadwerks/Documentat ... eButton.md

This makes the documentation modifiable by the public, but any modifications must be reviewed before they are pulled into the repository. If you like this system I could set up a copy of it up for you.
JoshKlint
 
Posts: 163
Joined: Sun Dec 10, 2017 8:03 pm

Re: Plans for documentation and working demos

Postby KKlouzal » Wed Dec 08, 2021 10:22 pm

Yes 4.0 has doxygen docs, but this is just a list of classes and functions, nice to have but only if you are already intimately familiar with the library.

Yes 4.0 has ndSandbox, albeit an extremely impressive demo sandbox, it is overly complicated from a newcomers perspective. I went round and round in circles for a couple days digging through ndSandbox source code only to end up confused and no further from where I started.

I have looked at the wiki. Sure it would be a great help if I was using version 2.0....

I think I learned more in the 5 minutes of looking at test.cpp file than the few days of digging through ndSandbox.

As a newcomer I need clear and concise examples of individual features, no frameworks. Start to finish self contained examples showcasing a particular feature.

At the moment I am left with a broken project that throws assert trying to create basic box shape rigid body but nowhere to look and see if I am initializing something wrong or anything along those lines. I will not give up though because I think 4.0 is the best physics library available today by far!
User avatar
KKlouzal
 
Posts: 16
Joined: Tue Jan 23, 2018 11:59 am

Re: Plans for documentation and working demos

Postby JernejL » Thu Dec 09, 2021 6:11 am

KKlouzal wrote:Y
I have looked at the wiki. Sure it would be a great help if I was using version 2.0....


Examples might be for 2.0 there, but documentation is for 3.0.
However it is for the C-layer api and not internals that match newton 4.. which i guess is not very good for the latest version but it is good to explain basic newton concepts (contacts, joints, bodies, shapes, callbacks.. )
Help improving the Newton Game Dynamics WIKI
User avatar
JernejL
 
Posts: 1578
Joined: Mon Dec 06, 2004 2:00 pm
Location: Slovenia

Re: Plans for documentation and working demos

Postby Julio Jerez » Thu Dec 09, 2021 6:35 pm

I will start adding the source doc, some classes are still going under changes
but after first stable release, I will start the documentation project
I will add the dixigen doc, basic single demos tutorials and re start the wiki.

for now I am focus in getting the first stable release.
Julio Jerez
Moderator
Moderator
 
Posts: 12249
Joined: Sun Sep 14, 2003 2:18 pm
Location: Los Angeles

Re: Plans for documentation and working demos

Postby KKlouzal » Thu Dec 09, 2021 7:38 pm

After I get settled and figure some things out I will contribute to the wiki as well.
User avatar
KKlouzal
 
Posts: 16
Joined: Tue Jan 23, 2018 11:59 am

Previous

Return to General Discussion

Who is online

Users browsing this forum: No registered users and 38 guests