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..dae2d78
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# cpp-utils
+
+This repository provides common utilities that I use in older code bases (old
+cpp std) and in experiments.
+
+Each utility is provided in a self-contained header file, which makes it easy
+to copy them over and adapt them to the concrete needs.
+
+The folder `test/` does not really provide tests, but it is more used as
+playground and to validate compilation :^)
+
+The [Makefile](Makefile) offer some target for building, running and linting
+the utilities.
+```sh
+# Build "test" examples.
+make
+
+# Run all tests.
+make run
+```
+
+## License
+This project is licensed under the [MIT](LICENSE) license.