aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..014a737
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+<h1 align="center">Tael</h1>
+<p align="center">
+ <b>C++98 Extensions for <a href="https://github.com/Fuwn/tatl">Tatl</a></b>
+</p>
+
+Tael is just a wrapper class of [Tatl](https://github.com/Fuwn/tatl); nothing more, nothing less.
+
+## Usage
+
+### Complex
+
+Tael can be used via it's included testing context and utilities.
+
+An example of this method of using Tatl can be seen in
+[`examples/addition.cc`](examples/addition.cc).
+
+## Examples
+
+More examples can be found in the [`examples/`](examples) directory.
+
+## License
+
+This project is licensed with the [GNU General Public License v3.0](LICENSE).