aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 12 insertions, 8 deletions
diff --git a/README.md b/README.md
index dbd1e2b..93029a0 100644
--- a/README.md
+++ b/README.md
@@ -4,15 +4,15 @@ If you found this page using a search engine, you may be looking for the
original [libctemplate](http://libctemplate.sourceforge.net) by Stephen C. Losen
libctemplates is a template expander written for use with HTML. It's goals are
-to be simple, versitile, and fast. This is a library that started off as a
+to be simple, versitile, and fast. This library started off as a
fork of libctemplate, but eventually became a total rewrite. libctemplate,
-the original, was built primarily for cgi applications. It was tightly coupled
-with file streams, while libctemplate**s** allows you to output templates to
-strings for use in any application. If you think libctemplates is missing a
-feature, feel free to suggest it to
+the original, was built primarily for cgi applications. libctemplate was
+tightly coupled with file streams, while libctemplate**S** renders templates to
+strings for use in any application, FastCGI or [Kore](kore.io), for example.
+If you think libctemplates is missing a feature, feel free to suggest it to
[alexandermpickering@gmail.com](mailto://alexandermpickering@gmail),
or, even better, write it yourself and send the patch! You can find
-instructions on createing and sending git patches [here](http://cogarr.net/source/cgit.cgi/?p=about)
+instructions on createing and sending git patches [here](http://cogarr.net/source/cgit.cgi/?p=about).
## Contents
@@ -27,13 +27,17 @@ instructions on createing and sending git patches [here](http://cogarr.net/sourc
## Installation
Run the make file. libctemplates should compile on any system with a c99
-complient c compiler. If you are on linux, run `make; make install`.
+complient c compiler. If you are on linux, run
+
+ make; make install
<section id="Usage"></section>
## Usage
Just include the ctemplates.h header and make sure you're linking against
-libctemplates.a
+libctemplates.a, for example:
+
+ gcc main.c -lctemplates
<section id="Quick refrence"></section>
## Quick refrence