Skip to content

Commit 458c31c

Browse files
committed
Update README.md for new args parser
1 parent de76915 commit 458c31c

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Ubuntu:
2727

2828
## Download
2929

30-
Get the `latest` snapshot release at: https://github.com/X65/emu/releases
30+
Get the `latest` snapshot release at: <https://github.com/X65/emu/releases>
3131

3232
## Build
3333

@@ -70,10 +70,25 @@ Linux
7070

7171
Windows
7272

73-
> build/emu.exe file=roms/SOTB.xex
73+
> build/emu.exe roms/SOTB.xex
74+
75+
Options use the GNU `--option` style; run `emu --help` for the full list.
7476

7577
### Opcode Breakpoints
7678

7779
The emulator supports opcode based breakpoints, if an specified opcode is executed, the emulator will stop. Possible breakpoint values are EA (NOP) 42 (WDM #xx) and B8 (CLV).
7880

79-
> build/emu.exe file=roms/SOTB.xex break=EA
81+
> build/emu --break EA roms/SOTB.xex
82+
83+
### WASM URL arguments
84+
85+
The web build has no command line, so arguments come from the page URL query
86+
string. `file=VALUE` becomes the positional ROM argument,
87+
and every other token maps to a long option (only the `--option[=value]` form is
88+
supported, but the `--` prefix may be omitted). For example:
89+
90+
emu.html?file=roms/SOTB.xex&crt=1,2,3&fullscreen
91+
92+
is equivalent to the native command line:
93+
94+
build/emu --crt 1,2,3 --fullscreen roms/SOTB.xex

0 commit comments

Comments
 (0)