Add README and LICENCE.HEADmaster

1 files changed, 26 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..868f3c3
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+Overview
+========
+
+This is a small C library providing an N-dimensional array object (á la numpy).
+Only the barest minimum has been implemented so far.
+
+If you modify the code, we ask that you share your changes with the author (e.g.
+via email).
+
+Building and installation
+=========================
+
+A C11-compliant compiler and a POSIX environment are expected. Simply run make
+to build the shared library, then copy it and the header to where your
+linker/compiler can find them (typically /usr/local/lib and /usr/local/include).
+
+Usage
+=====
+
+The public C API is described in the ndarray.h header.
+
+Licence
+=======
+
+This library is free software, available under GNU GPLv3 (see the LICENCE file
+for full licence text).