summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorKevin Chabowski <kevin@kch42.de>2011-09-21 00:37:31 +0200
committerKevin Chabowski <kevin@kch42.de>2011-09-21 00:37:31 +0200
commite503aff5ae41c16b2c0598203b1fed4082ab519d (patch)
treea9cc661bf03cba226581bcbf26241ae6153e71b6 /README.markdown
parentfa1b95982a05ca860ada827b9fbdc9def1ac8952 (diff)
downloadste-e503aff5ae41c16b2c0598203b1fed4082ab519d.tar.gz
ste-e503aff5ae41c16b2c0598203b1fed4082ab519d.tar.bz2
ste-e503aff5ae41c16b2c0598203b1fed4082ab519d.zip
Added license and readme file.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..bfaa4ad
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,36 @@
+Stupid Template Engine
+======================
+
+The Stupid Template Engine (STE) is a template engine for the PHP programming
+language.
+
+Requirements
+------------
+
+PHP >= 5.3
+
+Why should you use it?
+----------------------
+
+* It's syntax (inspired by Textpattern's template syntax) is very easy and
+ similar to the syntax of (X)HTML. So it should be easy for designers to learn
+ this system.
+* It has a simple, yet powerful plugin interface. You can easily define your
+ own template functions / tags. It is even possible to write them in the
+ template language itself, which makes it kind of a programming language...
+* It can transcompile templates into PHP.
+* You can use anonymous functions to define custom tags.
+
+Annoying things.
+----------------
+
+* The error messages the parser returns, when your template has errors, are not
+ very helpful, i.e. the position of the error is not returned. You have to seek
+ it yourself.
+* No caching. Could be slow on websites with many hits.
+
+WARNING
+-------
+
+Early development, that means that it might be pretty buggy at the moment...
+