gif-animation icon indicating copy to clipboard operation
gif-animation copied to clipboard

consolidate documentation

Open extrapixel opened this issue 4 years ago • 2 comments

At the moment we have the Readme in this repo and there is http://extrapixel.github.io/gif-animation/ (Github pages, served from the gh-pages branch of this repo).

We should decide where the docs live and update it use recent download links etc.

extrapixel avatar Oct 06 '21 00:10 extrapixel

I'd prefer the gh pages approach. There could be full user docs on ere is http://extrapixel.github.io/gif-animation/ The page can continue to serve as a landing page from folks coming from the processing library page. We could add some more examples and maybe also add actual gifs to the page, to demonstrate what can be done. Maybe even have some visual examples of what the disposal modes do.

The API docs could continue to live both on GH pages and in the README of this repo. Or the README could simply link the GH page.

opinions / ideas very welcome!

extrapixel avatar Oct 08 '21 13:10 extrapixel

I'd say use the page, the README exists in various versions with all the forks

n1ckfg avatar Oct 08 '21 16:10 n1ckfg