X-Git-Url: https://git.xonotic.org/?a=blobdiff_plain;f=README;h=7b5181e9afc12117d7750b05161ec1d2d48eb0ca;hb=234567cb9fd0d1dc32d50202b10ab7ce75d31f09;hp=c02e8e1cda33c9ace364c938cc2d4d98a5e7b0ff;hpb=5e218e4e3031f0a722f8d353c4b8e3b060369567;p=xonotic%2Fgmqcc.git

diff --git a/README b/README
index c02e8e1..7b5181e 100644
--- a/README
+++ b/README
@@ -78,7 +78,7 @@ Comments:
 	
 	Examples:
 		; this is allowed
-		# as it this
+		# as is this
 		FLOAT: foo 1 ; this is not allowed
 		FLOAT: bar 2 # neither is this
 	
@@ -102,7 +102,7 @@ Internal:
 	The Quake engine provides some internal functions such as print, to
 	access these you first must declare them and their names. To do this
 	you create a FUNCTION as you currently do. Adding a $ followed by the
-	number of the engine builtin will bind it to that builtin.
+	number of the engine builtin (negated).
 	
 	Examples:
 		FUNCTION: print $4
@@ -121,12 +121,37 @@ Misc:
 	and signs (+, -) however.
 	
 	Constants cannot be assigned values of other constants, their value must
-	be fully expressed inspot of the declration.
+	be fully expressed inspot of the declartion.
 	
 	No two identifiers can be the same name, this applies for variables allocated
 	inside a function scope (despite it being considered local).
 	
 	There exists one other keyword that is considered sugar, and that
-	is AUTHOR this keyword will allow you to speciy the AUTHOR(S) of
+	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).
+	
+////////////////////////////////////////////////////////////////////////
+/////////////////////// Quake C Documentation //////////////////////////
+////////////////////////////////////////////////////////////////////////
+TODO ....