Skip to content

Commit 336e392

Browse files
committed
Update documentation for 32x32 canvas support.
1 parent a0152c7 commit 336e392

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
sprite
22
======
33
Sprite is an ncurses-based sprite editor.
4-
You can use it to make and share pixel art.
4+
You can use it to create and share pixel art.
5+
6+
By default, sprite sets up a 16x16 pixel canvas.
7+
If you'd like the larger 32x32 pixel canvas,
8+
start sprite with the -e flag.
9+
It is the responsibility of the user to ensure the terminal is properly sized.
510

611
Requirements
712
------------
@@ -18,7 +23,3 @@ License
1823
-------
1924
ISC License.
2025
See `LICENSE` for details.
21-
22-
Todo
23-
----
24-
* 32x32 sprite canvas if the screen is big enough.

sprite.1

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,25 @@
2323
.Nd ncurses-based sprite editor
2424
.Sh SYNOPSIS
2525
.Nm
26+
.Op Fl e
2627
.Op Ar file
2728
.Sh DESCRIPTION
2829
.Nm
2930
is an ncurses-based sprite editor.
30-
You can use it to make and share pixel art.
31+
You can use it to create and share pixel art.
32+
.Pp
33+
The options are as follows:
34+
.Bl -tag -width Ds
35+
.It Fl e
36+
Use an extended canvas of 32x32 pixels instead of the default 16x16 pixels.
37+
.El
3138
.Sh AUTHORS
3239
.Nm
3340
was written by
3441
.An Brian Callahan Aq Mt bcallah@openbsd.org .
3542
.Sh CAVEATS
36-
.Nm
37-
only supports a 16x16 canvas.
38-
Support for a 32x32 canvas will be in a future version.
43+
It is the responsibility of the user to ensure the terminal is properly
44+
sized.
3945
.Pp
4046
Console aspect ratio may not match user expectations.
4147
PNG export creates standard square pixels.

0 commit comments

Comments
 (0)