ondras/primitive.js

Documentation

Closed this issue · 3 comments

darlanmendonca commented

Amazing project man!! I loved

How you wish make the documentation? In a simple Readme.md or in the gh-page?

ondras commented

Hi @darlanmendonca,

I definitely plan on adding some documentation (in the form of a typical README.md file). However, the tool is not yet ready for such task: the code needs some polishing, reorganization (individual Shapes into their own files) and most importantly, focus on parallelism. As you might have noted, there already is a Web Worker pool implementation (workerPool.js), but my rudimentary measurements do not show any reasonable speedup. I need to focus on this first, then on the docs.

darlanmendonca commented

hum, nice!!

A simple doc in README can be helpful to contributors

But now, how the project can be changed in any ways, I understand and agree :D

ondras commented

A rudimentary README.md file is ready :)