From: Dale Weiler <killfieldengine@gmail.com>
Date: Tue, 17 Apr 2012 09:20:36 +0000 (-0400)
Subject: Updated README
X-Git-Tag: 0.1-rc1~658
X-Git-Url: https://git.rm.cloudns.org/?a=commitdiff_plain;h=e650f9368b7cefaed99b7bac959190500f61747f;p=xonotic%2Fgmqcc.git

Updated README
---

diff --git a/README b/README
index b9f3a27..25dfd49 100644
--- a/README
+++ b/README
@@ -129,4 +129,24 @@ Misc:
 	There exists one other keyword that is considered sugar, and that
 	is AUTHOR, this keyword will allow you to speciy the AUTHOR(S) of
 	the assembly being assembled. The string represented for each usage
-	of AUTHOR is wrote to the end of the string table.
+	of AUTHOR is wrote to the end of the string table. Simaler to the
+	usage of constants and functions the AUTHOR keyword must be proceeded
+	by a colon.
+	
+	Examples:
+		AUTHOR: "Dale Weiler"
+		AUTHOR: "John Doe"
+		
+	Colons exist for the sole reason of not having to use spaces after
+	keyword usage (however spaces are allowed).  To understand the
+	following examples below are equivlent.
+	
+	Example 1:
+		FLOAT:foo 1
+	Example 2:
+		FLOAT: foo 1
+	Example 3:
+		FLOAT:  foo 2
+		
+	variable amounts of whitespace is allowed anywhere (as it should be).
+	think of `:` as a delimiter (which is what it's used for during assembly).