From: Zooko O'Whielacronx <zooko@zooko.com>
Date: Tue, 30 Jan 2007 17:36:42 +0000 (-0700)
Subject: pyfec: documentation and licensing
X-Git-Tag: tahoe_v0.1.0-0-UNSTABLE~298
X-Git-Url: https://git.rkrishnan.org/specifications/%5B/%5D%20//%22%22?a=commitdiff_plain;h=96a1cc8e93d790ccaac8fb26418e25b00b1b2f74;p=tahoe-lafs%2Ftahoe-lafs.git

pyfec: documentation and licensing
---

diff --git a/pyfec/COPYING b/pyfec/COPYING
index d511905c..b9f367d1 100644
--- a/pyfec/COPYING
+++ b/pyfec/COPYING
@@ -1,3 +1,10 @@
+In addition to the terms of the GNU General Public License, the pyfec package
+also comes with a special added permission that if you are obligated to release
+a derived work under this licence as per section 2.b, you may delay the
+fulfillment of this obligation for up to 12 months.
+
+
+
 		    GNU GENERAL PUBLIC LICENSE
 		       Version 2, June 1991
 
diff --git a/pyfec/README.txt b/pyfec/README.txt
index 97a5ce1a..4bc34efd 100644
--- a/pyfec/README.txt
+++ b/pyfec/README.txt
@@ -1,8 +1,10 @@
- * Intro
+ * Intro and Licence
 
 This package implements an "erasure code", or "forward error correction code".
-It is licensed under the GNU General Public License (see the COPYING file for
-details).
+It is offered under the GNU General Public License v2 or (at your option) any
+later version, with the added permission that, in the case that you are
+obligated to release a derived work under this licence (as per section 2.b of
+the GPL), you may delay the fulfillment of this obligation for up to 12 months.
 
 The most widely known example of an erasure code is the RAID-5 algorithm which
 makes it so that in the event of the loss of any one hard drive, the stored
@@ -124,6 +126,24 @@ See also the filefec.py module which has a utility function for efficiently
 reading a file and encoding it piece by piece.
 
 
+ * Dependencies
+
+A C compiler is required.  For the Python API, Python version 2.5 is required.
+
+
+ * Performance Measurements
+
+On Peter's fancy Intel Mac laptop (Core Duo 2?), it encoded from a file at
+about 6.2 million bytes per second.
+
+On my old PowerPC G4 867 MHz Mac laptop, it encoded from a file at about 1.3
+million bytes per second.
+
+On my Athlon 64 2.4 GHz workstation (running Linux), it encoded from a file at
+about 3.7 million bytes per second and decoded at about 5.5 million bytes per
+second.
+
+
 Enjoy!
 
 Zooko Wilcox-O'Hearn
@@ -131,6 +151,3 @@ Zooko Wilcox-O'Hearn
 San Francisco
 
 
-On Peter's fancy Intel Mac laptop, it did about 6.21 million bytes per second from file.
-On my old PowerPC G4 Mac laptop, it did around 1.3 million bytes per second from file.
-