Skip to content

Commit caa0293

Browse files
committed
Initial README.
1 parent 5e22940 commit caa0293

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
11
# JavaReedSolomon
2+
3+
This is a simple and efficient Reed-Solomon implementation in Java.
4+
5+
The ReedSolomon class does the encoding and decoding, and is supported
6+
by Matrix, which does matrix arithmetic, and Galois, which is a finite
7+
field over 8-bit values.
8+
9+
For examples of how to use ReedSolomon, take a look at SampleEncoder
10+
and SampleDecoder. They show, in a very simple way, how to break a
11+
file into shards and encode parity, and then how to take a subset of
12+
the shards and reconstruct the original file.
13+
14+
We would like to send out a special thanks to James Plank at the
15+
University of Tennessee at Knoxville for his useful papers on erasure
16+
coding. If you'd like an intro into how it all works, take a look at
17+
[this introductory paper](http://web.eecs.utk.edu/~plank/plank/papers/SPE-9-97.html).

0 commit comments

Comments
 (0)