Adding readme and license file.

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..752b39f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+novena_trng
+============
+This is an experimental HW system for the Novena platform.
+
+The purpose of the system is to debug, evaluate and qualify the
+Cryptech True Random Number Generator (TRNG) on the Novena platform with
+the Xilinx Spartan-6 FPGA. The entropy providers being tested are the noise
+based entropy provider and the ring oscillator based entropy provider.
+
+The following cores are used in the system:
+  - core/coretest, the test command parser
+
+  - core/i2c, the serial interface that connects the system to the
+    Novena CPU.
+
+  - core/avalanche_entropy, the entropy provider that is driven by an
+    external noise source.
+
+  - core/rosc_entropy, the entropy provider driven by jitter between 32
+  independently running ring oscillators in the FPGA.
+
+  - core/trng, the cryptech random number generator. This core uses the
+    ChaCha stream cipher core in core/chacha, the SHA-512 hash function
+    core in core/sha512
+
+Test SW is available in src/sw