Skip to content

Commit 70cc0c3

Browse files
committed
Updated README.md.
1 parent 674d9b5 commit 70cc0c3

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
1+
# Lua Scripts
2+
3+
[![Lua Scripts](https://github.com/Lethja/lua-scripts/actions/workflows/LuaScripts.yml/badge.svg)](https://github.com/Lethja/lua-scripts/actions/workflows/LuaScripts.yml)
4+
15
These are Lua scripts that are distributed with or help build
2-
[Lua for Watcom](https://github.com/Lethja/lua-watcom).
3-
The scripts range from simple demos to clones of unix utilities
4-
that are particularly useful on platforms that have no native equivalent.
6+
[Lua for Watcom](https://github.com/Lethja/lua-watcom)
7+
but are useful scripts that can be used with any Lua 5.4 compatible interpreter.
8+
The scripts range from simple demos to clones of unix utilities,
9+
which can be particularly useful on platforms that have no native equivalent.
510

611
Unfortunately, some scripts have been squashed
712
so they can all fit in the size limits of a floppy disk,
813
which can cause unintentional obfuscation of code.
9-
Unit tests have been created in these instances to make sure the script works
10-
as intended.
14+
Unit tests and separate documentation have been created
15+
in these instances to make sure the script works as intended.
1116

1217
The scripts are split into the following folders:
1318

1419
| Folder Name | Description |
1520
|------------------|--------------------------------------------------------------------------------------------------------------------------|
1621
| [bench](./bench) | Contains symbolic links to each script that is needed to run every benchmark in `BENCH.LUA` |
1722
| [core](./core) | Scripts that go in all distributions of Lua for Watcom, namely included in the 160K floppy disk image for really old PCs |
18-
| [test](./test) | Unit tests for scripts that require them |
23+
| [test](./test) | Unit tests and/or documentation for scripts |
1924
| [util](./util) | Scripts that help with the build process of Lua for Watcom but aren't included on any disk |
2025
| [xtra](./xtra) | Extra scripts that are omitted from the 160K floppy disk image duo to space constants |

0 commit comments

Comments
 (0)