ref: dd56666a4daac57bcaae217bf86c3bb41cd8ce17
parent: a5456e6c0abe933600de2de1b290b08e264953f2
author: phil9 <telephil9@gmail.com>
date: Tue Nov 29 16:17:46 EST 2022
improve README
--- a/README.md
+++ b/README.md
@@ -6,12 +6,12 @@
-------------
slug uses the [lu9-lua](https://git.sr.ht/~kvik/lu9-lua) native lua port to 9front by kvik.
1) Clone the slug repository somewhere.
-2) Clone the lu9-lua repository as lua within the slug directory
-3) mk && mk install
+2) Clone the lu9-lua repository as lua within the slug directory (`cd slug; git/clone https://git.sr.ht/~kvik/lu9-lua lua`)
+3) `mk && mk install`
Usage:
------
-A slug program is composed of two functions:
+A slug program is written in lua and composed of two functions:
- setup (not mandatory) which is called before the main draw loop.
- draw which is called in a loop until program exits.
@@ -21,7 +21,7 @@
- strokeWidth(n) change the width of strokes
- line(x1, y1, x2, y2) draw a line between points (x1,y1) and (x2, y2)
-colors:
+colors:
slug currently uses a 216 color palette based on web safe color palette.
color parameter is thus a number in the range [0;216[