search

extrapixel / gif-animation

GifAnimation is a Processing library to play and export GIF animations
GNU General Public License v3.0
171 stars 38 forks source link

consolidate documentation #31

Open extrapixel opened 2 years ago

extrapixel commented 2 years ago

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 commented 2 years ago

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!

n1ckfg commented 2 years ago

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