From f8cb3e39436966f0d490e0ec3735dd04d99b387c Mon Sep 17 00:00:00 2001
From: Anton Khirnov <anton@khirnov.net>
Date: Sun, 10 Oct 2021 15:38:46 +0200
Subject: Add README and LICENCE.

---
 README | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README

(limited to 'README')

diff --git a/README b/README
new file mode 100644
index 0000000..358cf7d
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+Overview
+========
+
+This is a small C library abstracting a thread pool, used by some other
+numerical relativity libraries. This implementation simply wraps OpenMP.
+
+If you modify the code, we ask that you share your changes with the author (e.g.
+via email).
+
+Building and installation
+=========================
+
+The library uses the meson build system. A C11-compliant compiler and a POSIX
+environment are expected.
+
+Usage
+=====
+
+The public C API is described in the threadpool.h header.
+
+Licence
+=======
+
+This library is free software, available under GNU GPLv3 (see the LICENCE file
+for full licence text).
-- 
cgit v1.2.3