First step towards Alpha board firmware release engineering.

Committing and pushing early so I can do initial test builds on
something with a little more horsepower.

1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ebf4015
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+Preliminary release engineering super-repository for building firmware
+for the Cryptech "Alpha" board.
+
+Primary tasks here are to build a bitstream for the FPGA and the
+"bootstrap" and "hsm" images for the Alpha's CPU.
+
+Eventually there will be a lot of packaging and versioning glorp here,
+but let's start with basic build and clean targets.
+
+Current repository structure is, um, complicated.  On the RTL side, we
+have a tree of simple subrepositories, each representing one RTL core.
+
+On the software side, we have a subrepository which has several
+subrepositories of its own: current thinking is that this should
+probably be replaced by separate repositories and Makefile VPATH
+magic, but this is what we have today so it's what we build with
+today.
+
+This README is probably obsolete by the time you're reading it.