gl-matrix icon indicating copy to clipboard operation
gl-matrix copied to clipboard

Improve the documentation

Open rezoner opened this issue 7 years ago • 5 comments

image

I believe that this is a great library. Maybe even the best way to work with matrix math. I enter the docs and I can tell that it has a hell lot of useful stuff that I am looking for - but it misses the one basic thing - at least the simplest example of how to use it. Is it a functional library? Is mat2 a constructor?

Of course I dwelled into the source and figured that out - but that's not the point and most of people won't.

Thank you for making this library and thank you in advance for making it more accessible.

rezoner avatar Aug 15 '17 08:08 rezoner

@toji I would be willing to write a bunch of examples. However, I'm not sure where those examples should be? In a .md file? In the README.md file? Or should the home page a have a link to a .html file/website with a bunch of examples?

stefnotch avatar Oct 17 '17 16:10 stefnotch

This issue is up for grabs. Ideally, a few simple examples would be in the Readme file.

And this picture would be quite nice image

stefnotch avatar Apr 04 '19 17:04 stefnotch

Since there are three entry points (sites where the google search leads for the first time) in my opinion they all should contain the copy paste of the short examples.

This is the frontpage, documentation and readme.md

The examples should display how to create a new vector/matrix and briefly explain the nature of (target, source, ...) pattern in most of the methods. In other words explain that this way one can decide to leave the source intact or mutate it.

rezoner avatar Apr 04 '19 18:04 rezoner

Another note regarding the docs: It might be nice to automatically load the library so that anyone can quickly test it out in the browser console.

stefnotch avatar Aug 29 '19 18:08 stefnotch

I just want to throw a semi-wild idea out here for documentation: some kind of graphical representation of some of these things could be amazing. For example, see https://noonat.github.io/intersect/#aabb-vs-point

I know this would be a fair amount of work to create these, but they'd also be pretty amazing in terms of expressing these abstract things visually.

mreinstein avatar Jun 05 '20 15:06 mreinstein