add license and readme

2 files changed, 44 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..edb7177
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Johannes Stölp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
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.