Skip to content

Commit 69a99e6

Browse files
authored
Reflect changes in the README.md
The README.md also sometimes has to be updated as many things inside the repository change. This change adds the idea that the instructions can also be executed, the examples that were added and that the project is not as far away from a more stable version as before.
1 parent 5ddb575 commit 69a99e6

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22
A library to parse and execute custom ASM.
33

44
> [!IMPORTANT]
5-
> This project is still under construction. Nothing has to work and probably nothing does work.
5+
> This project is still under construction. But it is nearly in a state that is very usable. 😄
66
77
It is a light‑weight Lua library that lets you define, parse and later execute a custom assembly‑like language. <br />
88
And the libary is deliberately minimal:
99
- No external dependencies – pure Lua 5.1+.
1010
- Pluggable instruction set – you decide which mnemonics exist and how their operands are interpreted.
1111
- Configurable syntax – label delimiters, immediate prefixes, register prefixes, etc., are all driven by a settings table.
1212
- Tokenizer abstraction – you can feed source from a string, a file, or any other stream by providing a get_next_line method.
13-
14-
The project is currently a prototype; the execution engine is not yet implemented, but the parsing infrastructure is functional enough to be used as a foundation for a custom assembler or a teaching tool.
13+
- Execute the code - you can also define the behaviour of the instruction and with that execute this code.
1514

1615
## Installation
1716
Because LuASM is a single Lua file, installation is straightforward:
@@ -30,7 +29,7 @@ luasm.lua # <-- the file you just saw
3029

3130
No external libraries are required; the code runs on any Lua interpreter (5.1, 5.2, 5.3, LuaJIT, etc.).
3231

33-
## Quick Start (stuff that currently works)
32+
## Quick Start
3433
```lua
3534
-- 1. Define the instruction set
3635
local instructions = {
@@ -72,5 +71,10 @@ Label: start -> line: 1
7271
3 jmp
7372
```
7473

74+
## Examples
75+
To see other examples, they can be found in the [`examples/`](examples) directory. To execute them the README inside this directory should be followed.
76+
77+
These examples are numbered so that they ban be viewed in sequential order.
78+
7579
## License
7680
LuASM is released under the MIT License – you are free to use, modify, and distribute it in your projects. See the [LICENSE](LICENSE) file for the full text.

0 commit comments

Comments
 (0)