Version 1.0.2
[gnuk/neug.git] / README
diff --git a/README b/README
index 7b2bec9..67d55ce 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 NeuG - a true random number generator implementation (for STM32F103)
 
-                                                           Version 1.0
-                                                            2013-11-xx
+                                                         Version 1.0.2
+                                                            2015-07-18
                                                           Niibe Yutaka
                                      Free Software Initiative of Japan
 
@@ -28,18 +28,15 @@ NeuG was named after my daughter, but I don't say she is noisy.
 Release notes
 =============
 
-This is new release of NeuG with Chopstx, version number bumped to
-1.0.  Basic features (generating random numbers) are stable, but newly
-added things like fraucheky (USB Mass Storage Class) support and
-reGNUal (firmware upgrad) support should be considered experimental.
+This is the second minor release of NeuG, after 1.0.
+
+Basic features (generating random numbers) are stable, but newly added
+things like fraucheky (USB Mass Storage Class) support and reGNUal
+(firmware upgrad) support should be considered experimental.
 
 Note that you need Chopstx (the thread library) as external source
 code (instead of ChibiOS/RT).
 
-The "boards" directory is now obsolete, it's for old versions of NeuG
-with ChibiOS/RT.  When you find a board under this directory, it means
-it doesn't work.  We leave them to port new NeuG.
-
 
 FAQ
 ===
@@ -55,8 +52,8 @@ A0-double-dash: STM32F2xx and STM32F4xx have built-in TRNG, it would
                 looks not that good).
 
 Q1: How fast is NeuG device?
-A1: It's more than 50 Ki-byte/sec for conditioned output (by SHA-256),
-    and more than 140 Ki-byte/sec for CRC-32 filtered output.
+A1: It's more than 80 kB/sec for conditioned output (by SHA-256), and
+    more than 280 kB/sec for CRC-32 filtered output (kB = 1000 byte).
 
 Q2: Should we check condition of noise sources?
 A2: Yes, we should.  Three continuous tests are implemented, following
@@ -70,19 +67,15 @@ Q3: Conditioning with SHA-256 sounds over-kill.  Why not simpler?
 A3: It is because NIST SP 800-90B mandates something like that for
     "full entropy source".  If your usage is as an entropy source for
     RNG-tools to feed entropy to your kernel, or use for computer
-    simulations, I think that CRC32 filtered output would be good
-    enough.  You can configure NeuG device by "stty -F /dev/ttyACM0
-    parenb parodd" to get raw data before SHA-256 conditioning
-    component.  With high speed hub, you'll get more than 240
-    Ki-byte/second .
+    simulations, I think that CRC-32 filtered output would be good
+    enough.
 
 
 Targets
 =======
 
-FST-01, Olimex STM32-H103, and STM32 part of STM8S Discovery Kit are
-supported.  Porting to CQ-STARM, STBee Mini, and STBee is not that
-hard.
+FST-01, Olimex STM32-H103, and STM32 part of STM8S Discovery Kit,
+STBee Mini, and STBee are supported.
 
 
 Souce code
@@ -90,7 +83,7 @@ Souce code
 
 NeuG source code is under src/ directory.
 
-Note that SHA-2 hash function implementation, src/sha256.c, is based
+Note that SHA-256 hash function implementation, src/sha256.c, is based
 on the original implementation by Dr. Brian Gladman.  See:
 
   http://gladman.plushost.co.uk/oldsite/cryptography_technology/sha/index.php
@@ -106,15 +99,15 @@ It is distributed under GNU General Public Licence version 3 or later
 External source code
 ====================
 
-To build NeuG device, you need external source code.
+NeuG is distributed with external source code.
 
 * chopstx/ -- Chopstx, the RT Thread Library
 
 * [optional] fraucheky/ -- Fraucheky, the GPL container
 
-It is available at:
+Those are available at:
 
-  http://gitorious.org/chopstx/chopstx
+  https://anonscm.debian.org/cgit/gnuk/chopstx/
 
 
 USB vendor ID and product ID (USB device ID)
@@ -235,7 +228,7 @@ Before using /dev/ttyACM0, you need to configure its TTY discipline.
 
 Then, you can use output of /dev/ttyACM0.
 
-When you want to get raw output (not conditioned), you can configure:
+When you want to get CRC-32 filtered output, you can configure:
 
   $ stty -F /dev/ttyACM0 parenb parodd
 
@@ -244,7 +237,7 @@ configure:
 
   $ stty -F /dev/ttyACM0 parenb -parodd
 
-And you can get conditioned output by configuring:
+And you can get SHA-256 conditioned output by configuring:
 
   $ stty -F /dev/ttyACM0 -parenb
 
@@ -346,10 +339,11 @@ Test results
 ============
 
 See files under the directory test-results, for test result of
-"rngtest" in rng-tools, NIST STS 2.1.1, and Dieharder.
+"rngtest" in rng-tools, NIST STS 2.1.1, Dieharder, and PractRand 0.92.
 
 I collect 110 files of 125MB (= 13750MB), and use scripts to invoke
-dieharder and rngtest.  Collecting 110 files, it took three days.
+dieharder and rngtest.  Collecting 110 files, it took more than two
+days.
 
 For NIST STS 2.1.1, I used only 10 files of size 125MB.
 
@@ -357,16 +351,16 @@ For NIST STS 2.1.1, I used only 10 files of size 125MB.
 Git Repository
 ==============
 
-NeuG is available in the Gnuk repository at Gitorious.org:
+NeuG is available in the Gnuk repository at:
 
-    http://gitorious.org/gnuk/neug
+    https://anonscm.debian.org/cgit/gnuk/gnuk/
 
 You can get it by:
 
-    $ git clone git://gitorious.org/gnuk/neug.git
+    $ git clone git://anonscm.debian.org/gnuk/gnuk/neug.git
 
 
-I put Chopstx as a submodule of Git.  Please do this:
+I put Chopstx and Fraucheky as a submodules of Git.  Please do this:
 
   $ git submodule init
   $ git submodule update
@@ -376,7 +370,13 @@ I put Chopstx as a submodule of Git.  Please do this:
 Information on the Web
 ======================
 
-Please use FST-01 Q&A Forum at: http://no-passwd.net/askbot/questions/
+Please see the FST-01 support pages:
+
+    http://www.gniibe.org/category/fst-01.html
+
+Please consider to join Gnuk-users mailing list:
+
+    https://lists.alioth.debian.org/mailman/listinfo/gnuk-users
 
 
 
@@ -385,4 +385,10 @@ Your Contributions
 
 FSIJ welcomes your contributions.  Please assign your copyright
 to FSIJ (if possible).
---
+
+
+Foot note
+==========
+
+If NeuG had a family name, it must be Kunisada.
+--