From 56198161ac4d6ea22a8f27e6cf1a56e64638b893 Mon Sep 17 00:00:00 2001 From: Tushar Gohad Date: Sun, 29 Jun 2014 07:38:27 -0700 Subject: Library directory structure skeleton Signed-off-by: Tushar Gohad --- 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..f9399ee --- /dev/null +++ b/README @@ -0,0 +1,25 @@ +## Introduction + +Liberasurecode is an erasure code library which can support multiple +erasure code 'backends'. The repository includes a Jerasure for Reed-Solomon +implementation. + +[TODO: flesh this out a bit more] + +## Dependencies + +liberasurecode requires that the following dependencies be installed: + +* gf-complete: http://www.kaymgee.com/Kevin_Greenan/Software_files/gf-complete.tar.gz +* Jerasure: http://www.kaymgee.com/Kevin_Greenan/Software_files/jerasure.tar.gz + +## Build + +To build the liberasurecode repository, perform the following from the root +directory of the repository: + +`$ ./configure` +`$ make` +`$ make test` +`$ sudo make install` + -- cgit v1.2.1