notimetoplay/genoa
notimetoplay
/
genoa
1
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Update notes and cheatsheet

This commit is contained in:
No Time To Play 2023-09-18 06:32:28 +00:00
parent 174c5f163e
commit e7e44c183d
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/manual.md
View File

@ -1,6 +1,8 @@
# Genoa user manual
Genoa is a tool to generate drawings out of simple scripts and preview them inline for rapid turnaround, then export them as SVG. Genoa shapes and options only cover a subset of SVG. Note that the preview isn't always exact, especially at small sizes and/or when it contains text.
Genoa is a tool to generate drawings out of simple scripts and preview them inline for rapid turnaround, then export them as SVG. Genoa shapes and options only cover the subset of SVG that can be easily previewed.
**Note** that the preview isn't always exact. Text renders differently from the exported output. Also the preview only shows dash patterns on lines; other shapes are always shown with solid outlines.
Genoa scripts are based on a safe subset of the Tcl programming language. A Tcl tutorial is outside the scope of this manual; see the examples to get started. Suffice to say, Genoa scripts are denied access to your files, or the network. There's also a safety limit of one million commands per render, to prevent an infinite loop locking up your computer.
@ -28,6 +30,8 @@ color $c
fill $f
# Width of lines / borders (default: 1).
width $w
# Dash pattern; should be one or more numbers, or else "".
dash $n...
# Font options
font $f
size $s
@ -48,4 +52,4 @@ alert $message
---
This cheatsheet applies to Genoa version 0.4 alpha from 14 September 2023.
This cheatsheet applies to Genoa version 1.0 beta from 18 September 2023.