Add readme and license filesHEADmaster

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..58c48f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+STM32 firmware for Cryptech Alpha board
+=======================================
+
+The Alpha board is our first full prototype for an open-source hardware
+security module (HSM). It is a custom board with an STM32 Cortex-M4
+microcontroller and an Artix-7 FPGA, flash-based keystore, separate memory
+for the Key Encryption Key, etc. See the wiki for design documents.
+
+Copyrights
+==========
+
+The license for all work done on this in the CrypTech project is a
+3-clause BSD license.
+
+The "Noise generator" and "Amplifier" parts of the circuit diagram are
+copied from Benedikt Stockebrand's ARRGH project. 
+
+Both copyright statements are included in LICENSE.txt.
+
+Board Revisions
+===============
+
+1. `rev01` was the "dev-bridge" board, a daughterboard for the Novena,
+   which talked to the Novena's FPGA through the high-speed expansion
+   connector.
+
+2. `rev02` is the Alpha board, our first full prototype for an open-source
+   hardware security module (HSM). It is a custom board with an STM32
+   Cortex-M4 microcontroller and an Artix-7 FPGA, flash-based keystore,
+   separate memory for the Key Encryption Key, etc.
+
+   The board's form factor (4 x 4 in, 101.6 x 101.6 mm) was based on the
+   Intel NUC mini-PC, but there were some issues sourcing enough cases, so
+   only a few of these boards were made.
+
+3. `rev03` is functionally the same as `rev02`, but in a Eurocard form
+   factor (100 x 120 mm, aka "3Ux120").