-NED - Numeric Evaluation Device
-===============================
+# NED - Numeric Evaluation Device #
-Description
------------
+## Description ##
NED is an experimental CPU architecture.
disassembler for the NED architecture. More details can be found in the
`README.md` located in the top level directory of each sub-project.
+A passive front panel, found in the `nedfp/` folder, works in conjunction with
+`nedsim`.
+
Among other things, the `docs/` folder contains an architecture manual,
instruction reference, and compatibility matrix for the various parts of NED.
The `software/` folder contains assembly programs written for the NED
architecture.
-Status
-------
+## Status ##
+
+Everything from the Architecture Manual is implemented except the CMPSWP instruction.
-NED is incomplete and subject to frequent breaking changes.
+The calculator located under `software/` provides a tested, working example.
-Installation
-------------
+## Installation ##
A convenience makefile is included in this top level directory with targets
`make all` and `make clean` which will compile/remove nedsim/nedasm/neddis.