Fill in missing documentation.

vydd / sketch

A Common Lisp framework for the creation of electronic art, visual design, game prototyping, game making, computer graphics, exploration of human-computer interaction, and more.

MIT License

1.39k stars 67 forks source link

Fill in missing documentation. #74

Closed Kevinpgalligan closed 9 months ago

Kevinpgalligan commented 1 year ago

I've filled in all the TODOs in the documentation, and have added some additional documentation for features that were added recently.

It would be nice to have a table of contents, since the README is quite large, but I'm not sure how to do that for .org files.

olnw commented 1 year ago

About the table of contents: my first thought was to export README.org into another Org file using Emacs. Normally this generates a TOC when exporting to other formats, like HTML. However, this didn't work. I looked at the source code for ox-org.el, and it doesn't seem like it can generate a TOC.

Perhaps one of these tools is necessary:

Gleefre commented 10 months ago

Wow, it is really nice.

FYI image function supports both relative and absolute width and height. If width / height is in the (0, 1) interval, relative width / height is used, if it is 1 and more, absolute value is used, and if it is 0 and lower, or nil, "default" width / height of the image is used.

Kevinpgalligan commented 9 months ago

Hey @Gleefre, thanks for all your suggestions! I'm traveling, currently, but can incorporate them when I get back next month.

Truthfully, however, I don't feel super motivated when it seems unlikely that the pull request will be merged anytime soon. I wonder if we could create a fork with our changes, and then keep working on that fork until the return of @vydd, at which point we could push the changes back to this repo!

Other things I would like to work on:

Improve the speed of writing to/drawing canvas.
Use OpenGL to draw polygons rather than relying on cl-geometry -- which, as you might have seen in the other issue, only works reliably with rational numbers and is quite slow.
Add an equivalent of p5js's loop() and noLoop().
Small quality of life improvements, like exporting functions to get the width/height of an image.

Gleefre commented 9 months ago

Sure, no rush with my comments :)

I too think a fork might be called for - I have multiple fixes and improvements in my fork too & I'd like to work on improving sketch in the future.

I'd suggest using my fork but I'll need to clean it up a little bit first. I'm open to concentrating on someone's else fork as well :).

Kevinpgalligan commented 9 months ago

Thanks for the merge, there's nothing to apologise for! I just suggested a fork to keep the momentum going on the repo, I don't feel you have any responsibility to keep updating it.