diff options
| author | Tushar Gohad <tushar.gohad@intel.com> | 2014-07-16 20:37:56 -0700 |
|---|---|---|
| committer | Tushar Gohad <tushar.gohad@intel.com> | 2014-07-16 20:37:56 -0700 |
| commit | b334b25a4d7259a2116688a653da97bf1f75f0e7 (patch) | |
| tree | a7151c1bc1e5440c935b2ecb3e99c609402fbb3b | |
| parent | 6b2c0850c398ad85ee4b4c12b47ae4fbfac40be2 (diff) | |
| download | liberasurecode-b334b25a4d7259a2116688a653da97bf1f75f0e7.tar.gz | |
Update README with code organization
Signed-off-by: Tushar Gohad <tushar.gohad@intel.com>
| -rw-r--r-- | README | 53 |
1 files changed, 47 insertions, 6 deletions
@@ -6,18 +6,59 @@ implementation. [TODO: flesh this out a bit more] -## Dependencies +## Code organization -liberasurecode requires that the following dependencies be installed: +``` +├── README +├── NEWS +├── COPYING +├── AUTHORS +├── INSTALL +├── ChangeLog +| +├── autogen.sh +├── configure.ac +├── Makefile.am +| +├── include +│ ├── erasurecode +│ │ ├── erasurecode.h --> liberasurecode frontend API header +│ │ └── erasurecode_backend.h --> liberasurecode backend API header +│ └── xor_codes +| +├── src +│ ├── erasurecode.c --> liberasurecode API implementation +| | (frontend + backend) +│ ├── backends +│ │ └── xor +│ │ └─── flat_xor_hd.c --> 'flat_xor_hd' erasure code backend +| | implementation +| | +│ ├── builtin +│ │ └── xor_codes --> XOR HD code backend, built-in to +| | | liberasurecode +│ │ ├── xor_code.c +│ │ └── xor_hd_code.c +| | +│ └── utils +│ └── chksum --> fragment checksum utils for erasure +│ ├── alg_sig.c coded fragments +│ └── crc32.c +└─── test --> Test routines + ├── builtin + │ └── xor_codes + ├── liberasurecode_test.c + └── utils +``` -* 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 +## Dependencies ## Build -To build the liberasurecode repository, perform the following from the root -directory of the repository: +To build the liberasurecode repository, perform the following from the +top-level directory: +`$ ./autogen.sh` `$ ./configure` `$ make` `$ make test` |