# HG changeset patch
# User William Astle <lost@l-w.ca>
# Date 1331825184 21600
# Node ID 83bb31ca8b6acc31c04e06adaed9fdf998f131e0
# Parent  17bd59f045afa07684865fb72f47ed35dbe04cd5
Elaborated the readme for the gcc6809 patch

As a result of feedback from pulkomandy@pulkomandy.tk, added additional text
to readme to clarify several aspects of the instructions and the nature of
the gcc6809 patch as compared to the "official" gcc6809.

diff -r 17bd59f045af -r 83bb31ca8b6a extra/README
--- a/extra/README	Sun Mar 11 16:05:54 2012 -0600
+++ b/extra/README	Thu Mar 15 09:26:24 2012 -0600
@@ -22,17 +22,36 @@
 The last number after the dash is a patch level for the specific patch. 
 These are different to the official gcc6809 releases in the following ways. 
 First, all the source for as-6809 is removed.  Also, the special "helper"
-makefile and directory is removed.  Also, as of this writing, the
-distribution side for gcc6809 has been down for months and the latest
-release was for gcc 4.3.4 which does not build on 64 bit linux.
+makefile and directory is removed. Also, as of this writing, the latest
+"official" release was for gcc 4.3.4 which does not build on 64 bit linux.
 
+In the event you have used the "official" gcc6809 with the default as6809
+assembler that comes with it, you should be aware that while lwasm is mostly
+compatible with it syntax wise, there are differences, particularly in
+pseudo operations and source line syntax (most notably that you must have
+whitespace preceeding assembler directives and instructions).  You will
+likely not run into these unless you are using inline asm. Refer to the
+lwtools documentation for the specific line format required by lwasm.
+
+It is worth noting that neither gcc6809 nor lwtools comes with a standard C
+library.
+
+It is also worth noting that for many projects, it will be more flexible to
+invoke lwlink directly rather than using the ld script or gcc as a front
+end. See the lwtools documentation for details on using lwlink.
 
 To use these scripts, you really need to understand how to build a gcc as a
 cross compiler. The basics are that you put the as, ld, and ar scripts
 whereever you plan to put your cross-development binaries. Then, when
 building the cross compiler, you tell it where the scripts are.
 
-The following work
+Please note that the following recipe is an example only. If you are
+planning to install multiple instances of gcc6809 for different targets, you
+will most certainly need to modify the steps below. Providing a complete
+understanding of building a gcc toolchain for cross compilation is well
+beyond the scope of this document.
+
+The following works for a single installation.
 
 1. Install the ar, as, and ld scripts named m6809-unknown-{as,ar,ld} in a
 directory in your path, say /usr/local/coco/bin/.