From 7c842d7d0d34360de928acb337108327a8098950 Mon Sep 17 00:00:00 2001 From: Alfredo Palhares Date: Tue, 5 Mar 2013 16:25:13 +0000 Subject: [PATCH] Documenatation about the Xephyr script with markdown. --- README => README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) rename README => README.md (50%) diff --git a/README b/README.md similarity index 50% rename from README rename to README.md index bbb49ca..690d007 100644 --- a/README +++ b/README.md @@ -1,9 +1,21 @@ -#Tyranic - A simple rule engine +Tyranic - A simple rule engine +------------------------------ -Shifty was great and served us well since the early days of the Awesome 3.* series, but just as +### Description +Shifty was great and served us well since the early days of the Awesome 3.\* series, but just as many kid aged TV stars, it havn't grown that well. Many of it's, once unique, features are now supported by the default awful.tag engine, adding legacy complexity to the code base and affecting performance. This is why Tyranic was created. It is a light rule engine offering pretty much the same rule system, -but without all the dynamic tag code. Note that dynamic tagging is now supported directly by awesome. \ No newline at end of file +but without all the dynamic tag code. Note that dynamic tagging is now supported directly by awesome. + +### Examples + +Install [Xephyr](http://www.freedesktop.org/wiki/Software/Xephyr) and run the following script + + sh utils/xephyr.sh start + +*Note:* The tyranical repository must be named awesome-tyranical for the script to work out of the box. + +Also see samples.rc.lua for a sample.