# HG changeset patch
# User John Tsiombikas <nuclear@member.fsf.org>
# Date 1426391793 -7200
# Node ID db0630e6a97bcaed8e623c64be2c5f18ea779bb4
# Parent  d872095206bf44c1fe724683108328d05732b3ee
added README file

diff -r d872095206bf -r db0630e6a97b README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sun Mar 15 05:56:33 2015 +0200
@@ -0,0 +1,12 @@
+Following along Jack Crenshaw's compiler tutorial:
+  http://compilers.iecc.com/crenshaw/
+
+Instead of turbo pascal, I'll be using C, and instead of motorolla 68k assembly,
+the compiler will emit 32bit x86 code, with a prologue and epilogue attached to
+make it assemble, link and run on GNU/Linux.
+
+Use the Makefile to build the compiler (the binary is called test).
+Use the COMPILE and RUN scripts, to compile and run programs written in the
+language invented by the tutorials.
+
+Versions of the code after each article is completed will be tagged in the repo.