Skip to content

Commit 60bfd86

Browse files
committed
Add help instructions to README
1 parent ef9f016 commit 60bfd86

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,21 @@ Just download the binary for your required OS and architecture from [releases](h
2020

2121
#### Usage
2222
`ARMed --help` will show all the usage details
23+
```
24+
ARMed version 1.0
25+
Author : https://github.com/coderick14
26+
27+
ARMed is a very basic emulator of the ARM instruction set written in Golang
28+
USAGE : ARMed [OPTIONS]... SOURCE_FILE
29+
30+
--all show all register values after an instruction, with updated ones in color
31+
--end show updated registers only once, at the end of the program. Overrides --all
32+
--no-log suppress logs of statements being executed
33+
--help display help
34+
35+
Found a bug? Feel free to raise an issue on https://github.com/coderick14/ARMed
36+
Contributions welcome :)
37+
```
2338

2439
---
2540

0 commit comments

Comments
 (0)