Hi,
I recently discovered the Newton Dynamics Engine. I was so impressed that I
created an account. This is my first post!
My main challenge has been the terse documentation. I know this has been
discussed before, and I will not warm it up again. Instead, I went ahead and
created an API documentation. Here it is:
http://newton-dynamics.readthedocs.io/en/apidoc/index.html
Under the hood it uses Doxygen/Sphinx based on Newton.cpp (with massive
refactorings in the doc-strings to make it Doxygen compatible).
The ReadTheDocs hosting is handy since it rebuilds the documentation whenever
someone pushes to the repo. It also free
The documentation contains simple installation instructions (Linux only) and
some very basic tutorials. These are a work in progress since they document
my journey as a Newton newcomer.
I would appreciate any (constructive) feedback on this endeavour, and whether
people think this is worth keeping.
Btw: the idea is not to replace the Wiki, but to ship a minimal set of "Getting
Started" instructions with the code base. Ideally, a CI system would ensure it
stays in sync... but I am getting ahead of myself