Merge pull request #683 from boriel/docs

doc: add USR function

Author: boriel

docs/about.md

@@ -1,7 +1,7 @@
-#About
+# About
 
 
-##About the ZX BASIC Project
+## About the ZX BASIC Project
 
 ZX BASIC is a [BASIC](http://en.wikipedia.org/wiki/BASIC) ''cross compiler''.
 It will compile BASIC programs (in your PC) for your [ZX Spectrum](http://en.wikipedia.org/wiki/Sinclair_ZX_Spectrum).
@@ -14,7 +14,7 @@ ZX BASIC syntax tries to maintain compatibility as much as possible with
 [Sinclair BASIC](http://en.wikipedia.org/wiki/Sinclair_BASIC), it also have many new features, mostly taken from
 [FreeBASIC](http://www.freebasic.net/wiki) dialect.
 
-###Platform Availability
+### Platform Availability
 Since it is written in python, it is available for many platforms, like Windows, Linux and Mac.
 You only need to have python installed on these. For windows, there also is an installable (.MSI) _compiled_
 version, which does not need python previously installed.

docs/abs.md

@@ -1,19 +1,19 @@
-#ABS
+# ABS
 
-##Syntax
+## Syntax
 
 
 ```
 ABS(numericExpression)
 ```
 
 
-##Description
+## Description
 
 Returns the absolute value of the given argument.
 Argument must be a numeric expression. Returned value has the same type as the input argument.
 
-##Examples
+## Examples
 
 
 ```
@@ -24,7 +24,6 @@ REM 'Will print 1
 ```
 
 
-##Remarks
+## Remarks
 
 * This function is 100% Sinclair BASIC Compatible
-

docs/acs.md

@@ -1,26 +1,26 @@
-#ACS
+# ACS
 
-##Syntax
+## Syntax
 
 ```
 ACS(numericExpression)
 ```
- 
 
-##Description
+
+## Description
 
 Returns the arc cosine value of the given argument.
 Argument must be a numeric expression. Returned value type is [float](types.md#Float).
 
-##Examples
+## Examples
 
 ```
 REM Arc cosine value
 PRINT "Arc Cosine value of a is "; ACS(a)
 ```
- 
 
-##Remarks
+
+## Remarks
 
 * This function is 100% Sinclair BASIC Compatible
 * If the given argument type is not float, it will be [converted](cast.md) to float before operating with it.

docs/architectures/6502.py.md

@@ -1,4 +1,4 @@
-#6502.py
+# 6502.py
 
 ```
   #!/usr/bin/python
@@ -165,7 +165,5 @@
     "SBC ?,Y": Opcode("SBC ?,Y", 1, 1, "f9 XX XX"),
     "SBC ?,X": Opcode("SBC ?,X", 1, 1, "fd XX XX"),
     "INC ?,X": Opcode("INC ?,X", 1, 1, "fe XX XX"),
-  
-  }
-
 
+  }

docs/architectures/68000.py.md

@@ -1,10 +1,10 @@
-#68000.py
+# 68000.py
 
 ```
   #!/usr/bin/python
   # -*- coding: utf-8 -*-
   # vim:ts=4:et:
-  #- important - this code is still incomplete and unacurrated 
+  #- important - this code is still incomplete and unacurrated
   class Opcode(object):
     ''' Describes opcodes and other info.
     '''
@@ -54,7 +54,7 @@
     "MOVE.W #$NN,A5": Opcode("MOVE.W #$NN,A5", 1, 1, "3A 7C XX XX"),
     "MOVE.W #$NN,A6": Opcode("MOVE.W #$NN,A6", 1, 1, "3C 7C XX XX"),
     "MOVE.W #$NN,A7": Opcode("MOVE.W #$NN,A7", 1, 1, "3E 7C XX XX"),
-  
+
     "MOVE.B D0,D0": Opcode("MOVE.B D0,D0", 1, 1, "10 00"),
     "MOVE.B D0,D1": Opcode("MOVE.B D0,D1", 1, 1, "12 00"),
     "MOVE.B D0,D2": Opcode("MOVE.B D0,D2", 1, 1, "14 00"),
@@ -119,7 +119,7 @@
     "MOVE.B D7,D5": Opcode("MOVE.B D7,D5", 1, 1, "1A 07"),
     "MOVE.B D7,D6": Opcode("MOVE.B D7,D6", 1, 1, "1C 07"),
     "MOVE.B D7,D7": Opcode("MOVE.B D7,D7", 1, 1, "1E 07"),
-  
+
     "MOVE.L D0,D0": Opcode("MOVE.L D0,D0", 1, 1, "20 00"),
     "MOVE.L D0,D1": Opcode("MOVE.L D0,D1", 1, 1, "22 00"),
     "MOVE.L D0,D2": Opcode("MOVE.L D0,D2", 1, 1, "24 00"),
@@ -184,7 +184,7 @@
     "MOVE.L D7,D5": Opcode("MOVE.L D7,D5", 1, 1, "2A 07"),
     "MOVE.L D7,D6": Opcode("MOVE.L D7,D6", 1, 1, "2C 07"),
     "MOVE.L D7,D7": Opcode("MOVE.L D7,D7", 1, 1, "2E 07"),
-  
+
     "MOVE.W D0,D0": Opcode("MOVE.W D0,D0", 1, 1, "30 00"),
     "MOVE.W D0,D1": Opcode("MOVE.W D0,D1", 1, 1, "32 00"),
     "MOVE.W D0,D2": Opcode("MOVE.W D0,D2", 1, 1, "34 00"),
@@ -249,7 +249,7 @@
     "MOVE.W D7,D5": Opcode("MOVE.W D7,D5", 1, 1, "3A 07"),
     "MOVE.W D7,D6": Opcode("MOVE.W D7,D6", 1, 1, "3C 07"),
     "MOVE.W D7,D7": Opcode("MOVE.W D7,D7", 1, 1, "3E 07"),
-  
+
     "ANDI.L #$NNNN,D0": Opcode("ANDI.L #$NNNN,D0", 1, 1, "02 80 XX XX XX XX"),
     "ANDI.L #$NNNN,D1": Opcode("ANDI.L #$NNNN,D1", 1, 1, "02 81 XX XX XX XX"),
     "ANDI.L #$NNNN,D2": Opcode("ANDI.L #$NNNN,D2", 1, 1, "02 82 XX XX XX XX"),
@@ -258,7 +258,7 @@
     "ANDI.L #$NNNN,D5": Opcode("ANDI.L #$NNNN,D5", 1, 1, "02 85 XX XX XX XX"),
     "ANDI.L #$NNNN,D6": Opcode("ANDI.L #$NNNN,D6", 1, 1, "02 86 XX XX XX XX"),
     "ANDI.L #$NNNN,D7": Opcode("ANDI.L #$NNNN,D7", 1, 1, "02 87 XX XX XX XX"),
-  
+
     "LSR.L D0,D0": Opcode("LSR.L D0,D0", 1, 1, "E0 A8"),
     "LSR.L D0,D1": Opcode("LSR.L D0,D1", 1, 1, "E0 A9"),
     "LSR.L D0,D2": Opcode("LSR.L D0,D2", 1, 1, "E0 AA"),
@@ -267,11 +267,11 @@
     "LSR.L D0,D5": Opcode("LSR.L D0,D5", 1, 1, "E0 AD"),
     "LSR.L D0,D6": Opcode("LSR.L D0,D6", 1, 1, "E0 AE"),
     "LSR.L D0,D7": Opcode("LSR.L D0,D7", 1, 1, "E0 AF"),
-  
+
     "LSR.L D5,D7": Opcode("LSR.L D5,D7", 1, 1, "EA AF"),
     "LSR.L D6,D7": Opcode("LSR.L D6,D7", 1, 1, "EC AF"),
     "LSR.L D7,D7": Opcode("LSR.L D7,D7", 1, 1, "EE AF"),
-  
+
     "SWAP D0": Opcode("SWAP D0", 1, 1, "48 40"),
     "SWAP D1": Opcode("SWAP D1", 1, 1, "48 41"),
     "SWAP D2": Opcode("SWAP D2", 1, 1, "48 42"),
@@ -280,7 +280,5 @@
     "SWAP D5": Opcode("SWAP D5", 1, 1, "48 45"),
     "SWAP D4": Opcode("SWAP D4", 1, 1, "48 44"),
     "SWAP D7": Opcode("SWAP D7", 1, 1, "48 47"),
-  
-  }
-
 
+  }

docs/architectures/adam.md

@@ -1,5 +1,3 @@
-#Adam
+# Adam
 
 * http://drushel.cwru.edu/atm/atm.html
-
-

docs/architectures/alphatronicpc.md

@@ -1,5 +1,3 @@
-#AlphatronicPC
+# AlphatronicPC
 
 * http://www.old-computers.com/museum/computer.asp?st=1&c=241
-
-

docs/architectures/amiga_500.md

@@ -1,17 +1,15 @@
-#Amiga 500
+# Amiga 500
 
-## Amos 
+## Amos
 From http://www.clickteam.com/eng/downloadcenter.php?i=58 (redirecting too fast) some Amos sources are available:
 * http://www.clickteam.com/webftp/files/2/5/AMOSCompiler.zip
 * http://www.clickteam.com/webftp/files/2/5/AMOS1_23.zip
 * http://www.clickteam.com/webftp/files/2/5/AMOS1_3.zip
 * http://www.clickteam.com/webftp/files/2/5/EasyAMOS.zip
 * http://stos.atari.st/theme_2_1.html
 
-## Blitz-Basic 
+## Blitz-Basic
 * http://www.blitz-2000.co.uk/
 
-## Amiga-Basic 
+## Amiga-Basic
 * http://www.amigacoding.com/index.php/AmigaBASIC
-
-

docs/architectures/amstrad_cpc.md

@@ -1,17 +1,15 @@
-#Amstrad CPC
+# Amstrad CPC
 
-## documentation 
+## documentation
 * http://cpcwiki.eu/index.php/Technical_documentation
 * www.cpcmania.com/Docs/Programming/Programming.htm
 
-## games with sources 
+## games with sources
 * http://www.mojontwins.com/juegos_mojonos/uwol-2-cpc/
 * http://www.mojontwins.com/juegos_mojonos/lala-prologue-cpc/
 
-## Locomotive Basic 
+## Locomotive Basic
 * http://www.qsl.net/hb9xch/computer/amstrad/locomotivebasic.html
 * http://www.grimware.org/doku.php/documentations/software/locomotive.basic/start
 * http://www.cpcwiki.eu/index.php/Locomotive_BASIC
 * http://rosettacode.org/wiki/Category:Locomotive_Basic
-
-

docs/architectures/apple_ii.md

@@ -1,5 +1,3 @@
-#Apple II
+# Apple II
 
 * Applesoft Basic: http://www.txbobsc.com/scsc/scdocumentor/
-
-