]> git.xonotic.org Git - xonotic/gmqcc.git/commitdiff
updated README
authorDale Weiler <killfieldengine@gmail.com>
Tue, 17 Apr 2012 09:12:05 +0000 (05:12 -0400)
committerDale Weiler <killfieldengine@gmail.com>
Tue, 17 Apr 2012 09:12:05 +0000 (05:12 -0400)
README

diff --git a/README b/README
index f18d3b001d948531ecd991e7316fe5e912a308c5..c02e8e1cda33c9ace364c938cc2d4d98a5e7b0ff 100644 (file)
--- a/README
+++ b/README
@@ -76,6 +76,12 @@ Comments:
        that you'd like to be ignored by the assembler. You can only comment
        blank lines, and not lines assembly already exists on.
        
        that you'd like to be ignored by the assembler. You can only comment
        blank lines, and not lines assembly already exists on.
        
+       Examples:
+               ; this is allowed
+               # as it this
+               FLOAT: foo 1 ; this is not allowed
+               FLOAT: bar 2 # neither is this
+       
 Functions:
        Creating functions is the same as declaring a constant, simply use
        FUNCTION followed by a colon, and the name (white space doesn't matter)
 Functions:
        Creating functions is the same as declaring a constant, simply use
        FUNCTION followed by a colon, and the name (white space doesn't matter)
@@ -119,3 +125,8 @@ Misc:
        
        No two identifiers can be the same name, this applies for variables allocated
        inside a function scope (despite it being considered local).
        
        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
+       the assembly being assembled. The string represented for each usage
+       of AUTHOR is wrote to the end of the string table.