Skip to content

Commit 9445b12

Browse files
borielboriel
authored
Merge pull request #985 from boriel-basic/docs
Docs
2 parents 9d14828 + fec3f92 commit 9445b12

36 files changed

+233
-133
lines changed

‎docs/about.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# About
22

33

4-
## About the ZX BASIC Project
4+
## About the Boriel BASIC Project
55

6-
ZX BASIC is a [BASIC](http://en.wikipedia.org/wiki/BASIC) ''cross compiler''.
7-
It will compile BASIC programs (in your PC) for your [ZX Spectrum](http://en.wikipedia.org/wiki/Sinclair_ZX_Spectrum).
8-
ZX BASIC is an <abbr title="Software Development Kit">SDK</abbr> entirely written in [python](http://www.python.org).
9-
The SDK is implemented using the [PLY](http://www.dabeaz.com/ply/) (Python Lex/Yacc) compiler tool.
10-
It translates BASIC to Z80 assembler code, so it is easily portable to other Z80 platforms (Amstrad, MSX).
11-
Other non Z80 targets could also be available in the future.
6+
Boriel BASIC (formerly known as _ZX BASIC_ and _Boriel ZX BASIC_) is a [BASIC](https://en.wikipedia.org/wiki/BASIC) ''cross compiler''.
7+
It will compile BASIC programs (in your PC) for your [ZX Spectrum](https://en.wikipedia.org/wiki/Sinclair_ZX_Spectrum).
8+
Boriel BASIC is an <abbr title="Software Development Kit">SDK</abbr> entirely written in [python](https://www.python.org).
9+
The SDK is implemented using the [PLY](https://www.dabeaz.com/ply/) (Python Lex/Yacc) compiler tool.
10+
It translates BASIC to Z80 assembler code, so it is easily portable to other Z80 platforms (Amstrad CPC, MSX).
11+
Other non-Z80 targets could also be available in the future.
1212

13-
ZX BASIC syntax tries to maintain compatibility as much as possible with
14-
[Sinclair BASIC](http://en.wikipedia.org/wiki/Sinclair_BASIC), it also have many new features, mostly taken from
15-
[FreeBASIC](http://www.freebasic.net/wiki) dialect.
13+
Boriel BASIC syntax tries to maintain as much compatibility as possible to that of
14+
[Sinclair BASIC](https://en.wikipedia.org/wiki/Sinclair_BASIC), but it also has many new features, mostly taken from
15+
[FreeBASIC](https://www.freebasic.net/wiki) dialect.
1616

1717
### Platform Availability
18-
Since it is written in python, it is available for many platforms, like Windows, Linux and Mac.
19-
You only need to have python installed on these. For windows, there also is an installable (.MSI) _compiled_
20-
version, which does not need python previously installed.
18+
19+
Boriel BASIC is available _natively_ for Windows (32bit and 64bit) and Linux (x64). For other platforms (i.e. Mac OS)
20+
you will need to have Python 3.12+ installed in your computer and download the version _with Python scripts_ from
21+
the [Archive](archive.md) page.

‎docs/abs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@
33
## Syntax
44

55

6-
```
6+
```basic
77
ABS(numericExpression)
88
```
99

1010

1111
## Description
1212

1313
Returns the absolute value of the given argument.
14-
Argument must be a numeric expression. Returned value has the same type as the input argument.
14+
Argument must be a numeric expression. The returned value has the same type as the input argument.
1515

1616
## Examples
1717

1818

19-
```
19+
```basic
2020
REM Absolute value
2121
LET a = -1
2222
PRINT "Absolute value of a is "; ABS(a)

‎docs/archive.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## Source Code
44
You can checkout the latest source code from the repository.
5-
See [https://github.com/boriel-basic/zxbasic](http://github.com/boriel/zxbasic) for instructions on how to clone the
5+
See [https://github.com/boriel-basic/zxbasic](http://github.com/boriel-basic/zxbasic) for instructions on how to clone the
66
repository (git).
77

88

99
## Latest Version
1010
You can contribute to ZX BASIC by reporting possible bugs or improvement suggestions at the
1111
[forum](http://www.boriel.com/forum) or in social media.
1212

13-
Latest stable version is <span style="color: green;">**1.18.1**</span>.
13+
The latest stable version is <span style={{color: "green"}}>**1.18.1**</span>.
1414
Click on the desired icon below to download the package suitable for your platform:
1515

1616
* [<img src="https://zxbasic.readthedocs.io/en/docs/img/win32.png" alt="win32zip" width="32px"/>
@@ -36,7 +36,7 @@ in your system).
3636

3737
### What's new
3838
To check out what's new on every version, have a look at the
39-
[Changelog](https://github.com/boriel/zxbasic/blob/master/Changelog.md) file.
39+
[Changelog](https://github.com/boriel-basic/zxbasic/blob/master/CHANGELOG.md) file.
4040

4141
## Older versions
4242
This is the official ZX Basic archive. If you require an older ZX BASIC version, please have a look

‎docs/dim.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A [type](types.md) is a name for the kind of data (`Integer`, `Byte`, `String`,
1212
DIM <variable_name>[,<variable_name>...] [AS <type>] [= <value>]
1313
```
1414

15-
Where _<type>_ can be one of **INTEGER**, **BYTE**, **FLOAT**, etc.
15+
Where `<type>` can be one of **INTEGER**, **BYTE**, **FLOAT**, etc.
1616
See the list of [available types](types.md). If type is not specified, **FLOAT** will be used, unless you use
1717
a suffix (usually called _sigil_) like `$` or `%`.
1818

@@ -46,7 +46,7 @@ Declaring a variable that has already been referenced in previous lines will res
4646

4747
### Examples of variable declarations
4848

49-
```
49+
```basic
5050
REM Declares 'a' as a 16 bit signed integer variable
5151
DIM a AS INTEGER
5252

‎docs/examples/4inarow.bas.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# 4 in a Row
22

3-
Program: 4inarow.bas
3+
## Program: 4inarow.bas
44

55
This program first appeared in MicroHobby ZX Spectrum Spanish magazine. It has a
66
nice AI in BASIC that plays smartly against the human in only 16Kb!
77

8-
```
8+
```basic
99
0 REM From MicroHOBBY magazine, Num. 18, page 27 :')
1010
1 BORDER 1: PAPER 1: INK 7: CLS : PRINT AT 10,10; FLASH 1;"STOP THE TAPE": PAUSE 200
1111
5 DIM M(8,6): DIM p,pp,n as FLOAT

‎docs/examples/circle.bas.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Circle.Bas
22

3-
```
4-
Program: circle.bas
5-
```
3+
## Program: circle.bas
64

7-
```
5+
6+
```basic
87
REM Sample circle drawing without using the CIRCLE command
98
109
DIM i, r, x, y, q as FLOAT

‎docs/examples/clock.bas.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Clock.Bas
22

3-
```
4-
Program: clock.bas
5-
```
6-
```
3+
## Program: clock.bas
4+
5+
```basic
76
REM From the ZX Spectrum MANUAL
87
REM A Clock program
98

‎docs/examples/clock2.bas.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Clock2.Bas
22

3-
```
4-
Program: clock2.bas
5-
```
6-
```
3+
## Program: clock2.bas
4+
5+
```basic
76
REM From the ZX Spectrum MANUAL
87
REM A Clock program
98

‎docs/examples/colors.bas.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Colors.bas
22

3-
```
4-
Program: colors.bas
5-
```
6-
```
3+
## Program: colors.bas
4+
5+
```basic
76
REM From the ZX Spectrum 48K Manual
87
98
DIM m, n, c AS BYTE

‎docs/examples/fact.bas.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Fact.bas
22

3-
```
4-
Program: fact.bas
5-
```
6-
```
3+
## Program: fact.bas
4+
5+
```vbnet
76
REM Factorial recursive test
87

98
function fact(x as ulong) as ulong

0 commit comments

Comments
 (0)