README cleanup

This commit is contained in:
swaits committed 2010-11-17 16:36:42 -08:00
1 parent 4e90bc1163
commit 889487107e
1 file changed
+18 -8
+18 -8
View File
@@ -4,16 +4,19 @@ cpp-signal
Introduction
------------
This is a simple C++ callback library. It's conceptually similar to FastDelegate,
with a primary goal of having an extremely simple, clean API. Secondary goals
include low memory (low template bloat), zero external dependencies, and a high
level of portability.
This is a simple C++ callback library. It's conceptually similar to
FastDelegate, Qt, and countless other "typesafe callbacks in C++" articles
across the web.
Usage
-----
This library was developed with a primary goal of having an extremely simple,
clean API. Secondary goals include low memory (low template bloat), zero
external dependencies, and a high level of portability.
Using the library is incredibly simple. First, add the files to your project, Makefile,
IDE, etc. Then, to use the library, simply include "signal.h".
Quick Start
-----------
Using the library is incredibly simple. First, add the files to your project,
Makefile, IDE, etc. Then, to use the library, simply include "signal.h".
Here's a simple example:
@@ -43,6 +46,13 @@ Here's a simple example:
}
}
More thorough examples...
-------------------------
Under the Hood
--------------
TO DO
-----