From 5dde553d6e2082fcf01d9c0e7e9a091179152710 Mon Sep 17 00:00:00 2001 From: Anton Khirnov Date: Sun, 10 Oct 2021 15:49:22 +0200 Subject: Add README and LICENCE. --- README | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README (limited to 'README') 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). -- cgit v1.2.3