Merge branch 'master' into ast-and-ir

[xonotic/gmqcc.git] / README

diff --git a/README b/README
index b9f3a27892ebc7e37962d0166dac82fb6040aa66..7b5181e9afc12117d7750b05161ec1d2d48eb0ca 100644 (file)
--- 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
        
@@ -121,7 +121,7 @@ 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).
@@ -129,4 +129,29 @@ 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).
+       
+////////////////////////////////////////////////////////////////////////
+/////////////////////// Quake C Documentation //////////////////////////
+////////////////////////////////////////////////////////////////////////
+TODO ....