summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorVito Caputo <vcaputo@pengaru.com>2022-05-25 13:49:41 -0700
committerVito Caputo <vcaputo@pengaru.com>2022-05-25 13:49:41 -0700
commit95156224a7974d67457b21fe2ec775bb1a620be3 (patch)
tree352a4987569cf51dcfa847c975f095bcf6e8ccde /README
parenta5851bf4e75867a7a232d75eb0fb4fc9674f3a23 (diff)
README: just a small update and mention website
eventually this file needs to get rewritten comprehensively with the original content moved somewhere like ORIGIN.txt or whatever.
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 26 insertions, 0 deletions
diff --git a/README b/README
index 5f4c952..ae4b2f7 100644
--- a/README
+++ b/README
@@ -1,3 +1,29 @@
+
+rototiller implements a corpus of software-rendered graphics modules,
+integrated into a single program.
+
+It can be used as a static library (libtil.a) embedded in other programs,
+or it can be used standalone to display stuff realtime via libdrm and/or
+SDL2.
+
+If you wish to see some eye candy, just build it in the conventional
+autotools project fashion:
+
+`./bootstrap; mkdir build; cd build; ../configure; make`
+
+If successful, run build/src/rototiller with no arguments for an
+interactive dialog to choose what to see. You can just smash enter a bunch
+for defaults and it will probably work. You can also just pass --defaults
+to achieve the same thing non-interactively.
+
+If you wish to hack on rototiller check out HACKING.txt in this tree.
+
+See https://rototiller.pengaru.com for more information.
+
+Everything below is out of date vestigial stuff from simpler times.
+
+-------------------------------------------------------------------------------
+
rototiller is, rendered entirely in software:
drizzle: a 2D raindrops visualization
flui2d: a 2D fluid dynamics simulation
© All Rights Reserved