about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--slugs/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/slugs/readme.md b/slugs/readme.md
new file mode 100644
index 0000000..f5dbe6b
--- /dev/null
+++ b/slugs/readme.md
@@ -0,0 +1,25 @@
+# slugs
+**s**mall, **l**ittle **g**id builder. (but with a u before the l an an s after the g so it's slugs 🥺)
+
+usage: `slugs <directory>`
+
+where directory looks something like this:
+directory  
+├ manifest.conf  
+├ palette
+├ frame1.tep  
+├ frame2.tep  
+├ frame3.tep
+
+and manifest.conf looking like:
+```
+Width 8
+Height 16
+Palette palette
+Delay 1
+
+Frame frame1.tep
+Frame frame2.tep
+	Delay 2
+Frame frame3.tep
+```
\ No newline at end of file