Skip to content

Commit e03d1f0

Browse files
committed
Fix README issues
There were some issues because of the previous change.
1 parent c5d361c commit e03d1f0

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A library to parse and execute custom ASM.
55
> 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 />
8-
And the libary is deliberately minimal:
8+
And the library 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.
@@ -22,6 +22,14 @@ git clone https://github.com/quickwrite/luasm.git
2222

2323
Or, if you just need the file:
2424

25+
```lua
26+
-- In your project directory
27+
luasm.lua # <-- the file you just saw
28+
```
29+
30+
No external libraries are required; the code runs on any Lua interpreter (5.1, 5.2, 5.3, LuaJIT, etc.).
31+
32+
## Quick Start
2533
```lua
2634
local LuASM = require("luasm")
2735

0 commit comments

Comments
 (0)