Commit 8a85c829d6c346122b4059f057833b7a61b7f00f

Authored by Jim Plank
1 parent 01322795
Exists in master and in 1 other branch v2

Added compilation instructions for when you don't have GF-Complete

installed as root.
Showing 3 changed files with 78 additions and 18 deletions   Show diff stats
README
... ... @@ -2,10 +2,11 @@ This is revision 2.0 of Jerasure. This is pretty much Jerasure 1.2 without the
2 2 original Galois Field backend. Version 2.0 links directly to GF-Complete, which
3 3 is more flexible than the original, and *much* faster, because it leverages SIMD
4 4 instructions.
5   -
6 5 Authors: James S. Plank (University of Tennessee)
7 6 Kevin M. Greenan (Box)
8 7  
  8 +------------------------------------------------------------
  9 +
9 10 External Documentation:
10 11  
11 12 See the file Manual.pdf for the programmer's manual and tutorial. This manual
... ... @@ -13,26 +14,45 @@ is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.
13 14  
14 15 See https://bitbucket.org/jimplank/gf-complete for GF-Complete.
15 16  
16   -NOTE: You must have GF-Complete installed in order to use Jerasure 2.0.
  17 +NOTE: You must have GF-Complete installed (or compiled) in order to use Jerasure 2.0.
17 18  
18 19 There are two directories of source code:
19 20  
20 21 The src directory contains the jerasure code.
21 22 The Examples directory contains the example programs.
22 23  
  24 +------------------------------------------------------------
  25 +
23 26 The makefile assumes that Examples is a subdirectory of the home directory.
24 27  
25   -Installing:
  28 +Installing if you are allowed to install GF-Complete on your machine:
26 29  
27 30 1.) Install GF-Complete
28 31 2.) ./configure
29 32 3.) make
30 33 4.) sudo make install
31 34  
32   -This will install the examples under PREFIX/bin, the library under PREFIX/lib
33   -and the header files under PREFIX/include
  35 +This will install the library into your machine's lib directory,
  36 +the headers into include, and the example programs into bin.
  37 +
  38 +------------------------------------------------------------
  39 +
  40 +Installing if you can compile GF-Complete, but you cannot install it:
  41 +
  42 +1.) Install GF-Complete. Let's suppose the full path to GF-Complete is
  43 + in the environment variable GFP
  44 +2A.) On Linux, set the environment variable LD_LIBRARY_PATH so that it
  45 + includes $GFP/src/.libs
  46 +2B.) On a mac, set the environment variable DYLD_LIBRARY_PATH so that it
  47 + includes $GFP/src/.libs
  48 +2.) ./configure LDFLAGS=-L$GFP/src/.libs/ CPPFLAGS=-I$GFP/include
  49 +3.) make
  50 +
  51 +The examples will be in the directory Examples. The include files will
  52 +be in the directory include, and the library will be called libJerasure.a
  53 +in the directory src/.libs.
34 54  
35   -Inclusion of GF-Complete:
  55 +------------------------------------------------------------
36 56  
37 57 As long as GF-Complete is installed, Jerasure 2.0 can be used just as previous
38 58 versions. There is no need to define custom Galois Fields. Jerasure will
... ...
README.nd
... ... @@ -2,10 +2,11 @@ This is revision 2.0 of Jerasure. This is pretty much Jerasure 1.2 without the
2 2 original Galois Field backend. Version 2.0 links directly to GF-Complete, which
3 3 is more flexible than the original, and *much* faster, because it leverages SIMD
4 4 instructions.
5   -
6 5 Authors: James S. Plank (University of Tennessee)
7 6 Kevin M. Greenan (Box)
8 7  
  8 +------------------------------------------------------------
  9 +
9 10 External Documentation:
10 11  
11 12 See the file Manual.pdf for the programmer's manual and tutorial. This manual
... ... @@ -13,26 +14,45 @@ is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.
13 14  
14 15 See https://bitbucket.org/jimplank/gf-complete for GF-Complete.
15 16  
16   -NOTE: You must have GF-Complete installed in order to use Jerasure 2.0.
  17 +NOTE: You must have GF-Complete installed (or compiled) in order to use Jerasure 2.0.
17 18  
18 19 There are two directories of source code:
19 20  
20 21 The src directory contains the jerasure code.
21 22 The Examples directory contains the example programs.
22 23  
  24 +------------------------------------------------------------
  25 +
23 26 The makefile assumes that Examples is a subdirectory of the home directory.
24 27  
25   -Installing:
  28 +Installing if you are allowed to install GF-Complete on your machine:
26 29  
27 30 1.) Install GF-Complete
28 31 2.) ./configure
29 32 3.) make
30 33 4.) sudo make install
31 34  
32   -This will install the examples under PREFIX/bin, the library under PREFIX/lib
33   -and the header files under PREFIX/include
  35 +This will install the library into your machine's lib directory,
  36 +the headers into include, and the example programs into bin.
  37 +
  38 +------------------------------------------------------------
  39 +
  40 +Installing if you can compile GF-Complete, but you cannot install it:
  41 +
  42 +1.) Install GF-Complete. Let's suppose the full path to GF-Complete is
  43 + in the environment variable GFP
  44 +2A.) On Linux, set the environment variable LD_LIBRARY_PATH so that it
  45 + includes $GFP/src/.libs
  46 +2B.) On a mac, set the environment variable DYLD_LIBRARY_PATH so that it
  47 + includes $GFP/src/.libs
  48 +2.) ./configure LDFLAGS=-L$GFP/src/.libs/ CPPFLAGS=-I$GFP/include
  49 +3.) make
  50 +
  51 +The examples will be in the directory Examples. The include files will
  52 +be in the directory include, and the library will be called libJerasure.a
  53 +in the directory src/.libs.
34 54  
35   -Inclusion of GF-Complete:
  55 +------------------------------------------------------------
36 56  
37 57 As long as GF-Complete is installed, Jerasure 2.0 can be used just as previous
38 58 versions. There is no need to define custom Galois Fields. Jerasure will
... ...
README.txt
... ... @@ -2,10 +2,11 @@ This is revision 2.0 of Jerasure. This is pretty much Jerasure 1.2 without the
2 2 original Galois Field backend. Version 2.0 links directly to GF-Complete, which
3 3 is more flexible than the original, and *much* faster, because it leverages SIMD
4 4 instructions.
5   -
6 5 Authors: James S. Plank (University of Tennessee)
7 6 Kevin M. Greenan (Box)
8 7  
  8 +------------------------------------------------------------
  9 +
9 10 External Documentation:
10 11  
11 12 See the file Manual.pdf for the programmer's manual and tutorial. This manual
... ... @@ -13,26 +14,45 @@ is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.
13 14  
14 15 See https://bitbucket.org/jimplank/gf-complete for GF-Complete.
15 16  
16   -NOTE: You must have GF-Complete installed in order to use Jerasure 2.0.
  17 +NOTE: You must have GF-Complete installed (or compiled) in order to use Jerasure 2.0.
17 18  
18 19 There are two directories of source code:
19 20  
20 21 The src directory contains the jerasure code.
21 22 The Examples directory contains the example programs.
22 23  
  24 +------------------------------------------------------------
  25 +
23 26 The makefile assumes that Examples is a subdirectory of the home directory.
24 27  
25   -Installing:
  28 +Installing if you are allowed to install GF-Complete on your machine:
26 29  
27 30 1.) Install GF-Complete
28 31 2.) ./configure
29 32 3.) make
30 33 4.) sudo make install
31 34  
32   -This will install the examples under PREFIX/bin, the library under PREFIX/lib
33   -and the header files under PREFIX/include
  35 +This will install the library into your machine's lib directory,
  36 +the headers into include, and the example programs into bin.
  37 +
  38 +------------------------------------------------------------
  39 +
  40 +Installing if you can compile GF-Complete, but you cannot install it:
  41 +
  42 +1.) Install GF-Complete. Let's suppose the full path to GF-Complete is
  43 + in the environment variable GFP
  44 +2A.) On Linux, set the environment variable LD_LIBRARY_PATH so that it
  45 + includes $GFP/src/.libs
  46 +2B.) On a mac, set the environment variable DYLD_LIBRARY_PATH so that it
  47 + includes $GFP/src/.libs
  48 +2.) ./configure LDFLAGS=-L$GFP/src/.libs/ CPPFLAGS=-I$GFP/include
  49 +3.) make
  50 +
  51 +The examples will be in the directory Examples. The include files will
  52 +be in the directory include, and the library will be called libJerasure.a
  53 +in the directory src/.libs.
34 54  
35   -Inclusion of GF-Complete:
  55 +------------------------------------------------------------
36 56  
37 57 As long as GF-Complete is installed, Jerasure 2.0 can be used just as previous
38 58 versions. There is no need to define custom Galois Fields. Jerasure will
... ...