From be87d016eb3e25ca132337b766589d772fa4d290 Mon Sep 17 00:00:00 2001 From: Johannes Middeke Date: Fri, 6 May 2016 12:57:44 -0400 Subject: [PATCH] Added some documentation. --- README | 18 ++++++++++++++++++ TODO | 5 +++++ 2 files changed, 23 insertions(+) create mode 100644 README create mode 100644 TODO diff --git a/README b/README new file mode 100644 index 0000000..e9ca2ff --- /dev/null +++ b/README @@ -0,0 +1,18 @@ +This project contains an implementation of the L D^{-1} U +decomposition for matrices over integral domains. Included example +domains are the integers and the polynomials over GF(2). Users can +freely define their own domains using the signature in matrix.ml. + +The program depends on the Zarith library for handling big integers. + +The project uses OASIS as its build tool. Use the commands + + oasis setup + ocaml setup.ml -all + +in order to compile. This will create an executable file + + test.native + +in the top directory. + diff --git a/TODO b/TODO new file mode 100644 index 0000000..507e8bb --- /dev/null +++ b/TODO @@ -0,0 +1,5 @@ +* Eliminate Tools + + Try to eliminate the dependency on the tools library. Otherwise I + would have to publish tools, too. + -- 2.1.4