Copyleft (K) 2008, Jose Rodriguez-Rosa (a.k.a. Boriel) http://www.boriel.com

All files within this project are covered under de LGPL3-like LICENSE (Read http://www.gnu.org/licenses/lgpl.html).

You can create closed-source (even commercial ones!) programs with this compiler (a mention to this tool will be welcome, though). But you are not allowed to release the compiler itself as a closed Source program.

If you modify this project (the compiler .py, .asm or whathever) files in any way you MUST publish the changes you made and submit your contribution to the community under the same license.

This is a very little help file.

For DOCUMENTATION in English go to the ZX BASIC Wiki: http://www.zxbasic.net

For help, support, updates meet the community at my forum: http://www.boriel.com/forum/zx-basic-compiler

Go to the ZXBasic download page http://www.boriel.com/wiki/en/index.php/ZX_BASIC:Archive and get the version most suitable for you.

There are, basically, two flavors (both with identical capabilities):

• For Windows you can download de win32 executable (Windows .exe zip package) version. To install just uncompress it in a directory of your choice. The main executable is zxb.exe (more on this later). With this toolchain also comes zxbasm.exe (the assembler) and zxbpp.exe (the preprocessor), but these are not needed when programming in BASIC.

• For Linux and Mac OSX there is a python version, so you will need a python interpreter (available on many platforms, and usually already installed in Linux and Mac OSX). Just uncompress it in a directory of your choice and installation is done. :-) The main executables are zxb.py (the compiler), zxbasm.py (the assembler) and zxbpp.py (the preprocessor). You can use this version in Windows, but will need to install a python interpreter first.

An in-game screenshot of Eleuterio by @na_th_an	Ingame screenshot of El Hobbit by @Wilco2000	Ingame screenshot of Knignt and Demonds DX by Einar Saukas

See more examples at http://www.boriel.com/wiki/en/index.php/ZX_BASIC:Released_Programs

For a quick start, just open a terminal in your PC in the same directory you uncompressed ZX Basic and type zxb (on Windows) or zxb.py (OSX, Linux). You should see a zxbasic message like this:

usage: zxb [-h] [-d] [-O OPTIMIZE] [-o OUTPUT_FILE] [-T] [-t] [-B] [-a] [-A]
           [-S ORG] [-e STDERR] [--array-base ARRAY_BASE]
           [--string-base STRING_BASE] [-Z] [-H HEAP_SIZE] [--debug-memory]
           [--debug-array] [--strict-bool] [--enable-break] [-E] [--explicit]
           [-D DEFINES] [-M MEMORY_MAP] [-i] [-I INCLUDE_PATH] [--strict]
           [--version]
           PROGRAM
zxb: error: the following arguments are required: PROGRAM

Create a text file with the following content:

10 CLS
20 PRINT "HELLO WORLD!"

Save it as hello.bas and finally compile it with:

zxb -taB hello.bas

If everything went well, a file named hello.tap should be created. Open it with your favourite emulator (i.e. fuse) and see the result.

Congratulations! You're now ready to create compiled BASIC programs for your machine. Check and compile the examples included in the examples/ folder or go to the Wiki http://zxbasic.net for further info.

These are some people who has contributed in a way or another. I consider some of them co-authors (Britlion, LCD) of this project.

Thanks to:

• Andre Adrian [adrianandre AT compuserve.de] from which I ripped the 32 bits Z80 MULT and DIV routines. See: http://www.andreadrian.de/oldcpu/Z80_number_cruncher.html

• Matthew Wilson [matthew AT mjwilson.demon.co.uk] and Andy [fract AT zx-81.co.uk] from comp.sys.sinclair for their help on ROM FP-CALC usage.

• Mulder http://www.worldofspectrum.org/forums/member.php?u=1369 from World Of Spectrum for finding the nasty PRINT AT bug and the GTU8 bug. See: http://www.worldofspectrum.org/forums/showthread.php?p=278416&posted=1#post278416

• Compiuter http://www.speccy.org/foro/memberlist.php?mode=viewprofile&u=73 from Speccy.org for finding a bug in PRINT OVER 1 routine.

• Britlion http://www.boriel.com/forum/member/britlion/ for his HUGE contribution (both in optimizations, ideas and libraries).

• LCD http://members.inode.at/838331/index.html Author of the BorIDE, which has also made many contributions to the project.

• There are several more contributions (e.g. Thanks to them for their intensive testing!). And thank you all (the entire community) for your interest!

If you have contributed in some way to this project, please, tell me so I'll add you to this list.