Skip to content

Commit 504bad3

Browse files
LethjaLethja
committed
Updated documentation with winnt version information and a binary compatibility matrix between the versions
1 parent 1f82360 commit 504bad3

File tree

1 file changed

+31
-12
lines changed

1 file changed

+31
-12
lines changed

‎README.md‎

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,37 @@
11
# Lua for Open Watcom
22

3-
This repository contains wmake style makefiles and patches to build [Lua](https://lua.org) on Open Watcom 1.9 or later.
4-
The primary goal is to allow Lua scripts to be run on DOS systems in real mode.
3+
This repository contains `wmake` style makefiles and patches to build [Lua](https://lua.org) on Open Watcom 1.9 or later.
4+
The primary goal was to allow Lua scripts to be run on DOS systems in real mode but has expanded
5+
to include all Open Watcom targets that don't require external dependencies to build.
56

67
## Runtime Requirements
7-
To run Lua built by Open Watcom you will need the following:
88

9-
| Requirement | Sources/Comment |
10-
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
11-
| [8088 CPU](https://en.wikipedia.org/wiki/Intel_8088)*<br/> <pre>*or compatibiles<br/>like the 8086, V20,<br/>286, 386 etc<br/><br/>Machine emulators<br/>provided as an alternative<br/>for other ISAs</pre> | [86Box](https://86box.net/) ([GitHub](https://github.com/86Box/86Box))<br/>[DOSBox-X](https://dosbox-x.com/) ([GitHub](https://github.com/joncampbell123/dosbox-x))<br/>[PCem](https://www.pcem-emulator.co.uk/) ([GitHub](https://github.com/sarah-walker-pcem/pcem/)) |
12-
| PC-DOS 2.1 or higher | [FreeDOS](https://www.freedos.org/download/)<br/>[DOSBox-X](https://dosbox-x.com/) ([GitHub](https://github.com/joncampbell123/dosbox-x))<br/>[SvarDOS](http://svardos.org/) |
13-
| At least 320 kilobytes<br/>of total system memory | <pre>Any memory above<br/>640 kilobytes is<br/>inaccessible to all<br/>real mode DOS programs |
14-
| At least 600 kilobytes<br/>of hard disk space or x2<br/>360 kilobyte diskettes | <pre>Can be ran directly<br/>from a diskette on<br/>machines without a<br/>hard drive |
9+
Lua for Watcom binaries can run on a number of legacy systems as well as some modern ones.
1510

16-
> If in doubt, install [DOSBox-X](https://dosbox-x.com/)
11+
### Absolute Minimum Requirements
12+
13+
These are the absolute lowest system requirements needed for a PC to run `LUA16.EXE`.
14+
15+
| Type | Requirement | Remarks |
16+
|----------------------|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
17+
| CPU | [8086 compatible](https://en.wikipedia.org/wiki/Intel_8086) | <pre>Compatibles like<br/>the Intel 8088, NEC V20,<br/>286, 386 etc<br/><br/>Machine emulators<br/>provided as an alternative<br/>for other ISAs</pre>[86Box](https://86box.net/) ([GitHub](https://github.com/86Box/86Box))<br/>[DOSBox-X](https://dosbox-x.com/) ([GitHub](https://github.com/joncampbell123/dosbox-x))<br/>[PCem](https://www.pcem-emulator.co.uk/) ([GitHub](https://github.com/sarah-walker-pcem/pcem/)) |
18+
| Operating System | PC-DOS 2.0 | [FreeDOS](https://www.freedos.org/download/)<br/>[DOSBox-X](https://dosbox-x.com/) ([GitHub](https://github.com/joncampbell123/dosbox-x))<br/>[SvarDOS](http://svardos.org/) |
19+
| Random Access Memory | At least 512 kilobytes<br/>of base system memory | <pre>Any memory above<br/>640 kilobytes is<br/>inaccessible to all<br/>real mode DOS programs |
20+
| Storage | At least 150 kilobytes<br/>of free disk space | <pre>Can be ran directly<br/>from a diskette on<br/>machines without a<br/>hard drive |
21+
22+
### Binary Compatibility Matrix
23+
24+
| Operating System | Minimum CPU ISA | LUA16.EXE | LUA4G.EXE | LUANT.EXE |
25+
|--------------------------------------------------------------------------|----------------------------|-----------|-----------|-----------|
26+
| DOS 2.0+ | 8086 | Yes | No | No |
27+
| DOS 5.0+ | 8086<br>80386SX | Yes | No<br>Yes | No |
28+
| Windows<br/>Windows 2<br/>Windows 3<br/>Windows 3.1 | 8086 | Yes | No | No |
29+
| Windows 95 | 80386SX | Yes | Yes | Yes |
30+
| Windows 98 | 80486SX+80487SX<br>80486DX | Yes | Yes | Yes |
31+
| Windows 2000<br/>Windows ME | 80586 | No | No | Yes |
32+
| Windows XP | 80586<br/>x86_64 | No | No | Yes |
33+
| Windows Vista<br/>Windows 7<br/>Windows 8<br/>Windows 8.1<br/>Windows 10 | 80686<br/>x86_64 | No | No | Yes |
34+
| Windows 11 | x86_64 | No | No | Yes |
1735

1836
## Build Requirements
1937
To build Lua with Open Watcom you will need the following:
@@ -22,11 +40,11 @@ To build Lua with Open Watcom you will need the following:
2240
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2341
| Lua 5.4 source code (or build machine with `git submodules`) | [lua.org](https://lua.org/ftp/) ([GitHub](https://github.com/lua/lua/tree/v5.4.6)) |
2442
| Open Watcom 1.9 (or later) | [openwatcom.org](https://www.openwatcom.org/) ([GitHub](https://github.com/open-watcom))<br/>[FreeDOS Bonus CD](https://www.freedos.org/download/) (`FDIMPLES`)<br/>[SvarDOS](http://svardos.org/?p=repo) (`PKGNET` repository) |
25-
| DOS operating system<br/>(MS-DOS 5.0 compatible) | [FreeDOS](https://www.freedos.org/download/)<br/>[DOSBox-X](https://dosbox-x.com/) ([GitHub](https://github.com/joncampbell123/dosbox-x))<br/>[SvarDOS](http://svardos.org/) |
43+
| Operating System supported by Open Watcom<br/>(at least MS-DOS 5.0) | [FreeDOS](https://www.freedos.org/download/)<br/>[DOSBox-X](https://dosbox-x.com/) ([GitHub](https://github.com/joncampbell123/dosbox-x))<br/>[SvarDOS](http://svardos.org/) |
2644
| [80386 compatible processor](https://en.wikipedia.org/wiki/I386)* <br/> <pre>*Any AMD or Intel CPU <br/>made in the last 3 decades<br/>is compatible.<br/><br/>Machine emulators provided <br/>as an alternative for other ISAs </pre> | [86Box](https://86box.net/) ([GitHub](https://github.com/86Box/86Box))<br/>[DOSBox-X](https://dosbox-x.com/) ([GitHub](https://github.com/joncampbell123/dosbox-x))<br/>[PCem](https://www.pcem-emulator.co.uk/) ([GitHub](https://github.com/sarah-walker-pcem/pcem/))<br/>[Qemu](https://www.qemu.org/) ([GitLab](https://gitlab.com/qemu-project/qemu)) |
2745
| A patching utility | [GNU Patch](https://savannah.gnu.org/projects/patch/)<br>[DifPat](https://github.com/deverac/difpat) |
2846

29-
> If in doubt, install [DOSBox-X](https://dosbox-x.com/)
47+
> If in doubt, [DOSBox-X](https://dosbox-x.com/) can be used on a modern machine
3048
3149
## How to build
3250
1) Extract Luas source code to the `Lua` folder. This can be achieved in two ways:
@@ -48,6 +66,7 @@ To build Lua with Open Watcom you will need the following:
4866
|-------------------------|----------------------|-------------|--------------------|
4967
| `wmake -f wm_dos16.mak` | `dist/bin/lua16.exe` | PC-DOS 2.0+ | 8086/8088 or later |
5068
| `wmake -f wm_dos4g.mak` | `dist/bin/lua4g.exe` | MS-DOS 5.0+ | 80386 or later |
69+
| `wmake -f wm_dosnt.mak` | `dist/bin/luant.exe` | Windows 95+ | 80386 or later |
5170

5271

5372
Other targets may work but are untested

0 commit comments

Comments
 (0)