summaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..475387b
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+Welcome to MDK.
+
+MDK stands for MIX Development Kit and provides tools for developing
+and executing, in a MIX virtual machine, MIXAL programs. The MIX
+is Donald Knuth's mythical computer, described in the first volume
+of _The Art of Computer Programming_ (Addison Wesley, 1997), which
+is programmed using MIXAL, the MIX Assembly language.
+
+Currently, MDK includes a MIXAL assembler, mixasm, and a MIX virtual
+machine, mixvm, with a command line interface.
+
+MDK is free software. Please see the file COPYING for details.
+For documentation, please see the files in the doc subdirectory.
+For building and installation instructions please see the INSTALL file.
+For sample MIXAL programs, please see the samples subdirectory.
+For translations (MDK uses GNU's gettext), please see the po subdirectory[0].
+
+--
+[0] New translations are welcome. If you'd like to contribute one,
+ please contact the author, jaortega@acm.org. \ No newline at end of file