From 109a51a147699e488ab80a773dab335d14531425 Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Wed, 10 Jul 2024 21:14:12 +0200 Subject: [PATCH] Docstring --- README.md | 9 --------- spritesheet.lua | 17 +++++++++++++---- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 30f7056..e69de29 100644 --- a/README.md +++ b/README.md @@ -1,9 +0,0 @@ -# Spritesheet - -Tiny library for working with textures and animated textures. - -## Notes - -- When drawing an image or animation when a shader is defined the library may - send certain useful constants along, notably `spritesheet_inverse_width` and -`spritesheet_inverse_height`. diff --git a/spritesheet.lua b/spritesheet.lua index 154ae6f..3178809 100644 --- a/spritesheet.lua +++ b/spritesheet.lua @@ -1,7 +1,16 @@ ---- Library for managing spritesheets. ---- ---- Has support for both individual images in spritesheets and animations. This ---- can be specified from a lua file placed beside the spritesheet image file. +--[[-- # Spritesheet + +Library for managing sprite sheets of textures and animations. + +Has support for both individual images in spritesheets and animations. This +can be specified from a lua file placed beside the spritesheet image file. + +## Notes + +- When drawing an image or animation when a shader is defined the library may + send certain useful constants along, notably `spritesheet_inverse_width` and +`spritesheet_inverse_height`. +--]] local error_original = error local error, error_internal do