Skip to content

Commit

Permalink
docs(README.md): ✏️ Update docs to show the newest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
kamack38 committed Feb 6, 2024
1 parent 2c00475 commit cd60242
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,32 @@ cargo install --git https://github.com/kamack38/ram-machine
## Usage

```
ram <ram code file> [input arguments]
RAM machine code interpreter
Usage: ram [OPTIONS] <COMMAND>
Commands:
run Run ram machine code from file
help Print this message or the help of the given subcommand(s)
Options:
-i, --input-file <FILE> Specifies the path to the input file from which data will be read (input passed from the command line takes precedence)
-o, --output-file <FILE> Specifies the path to the output file where the results will be written
-q, --quiet Don't pass code output to STDOUT
-h, --help Print help
-V, --version Print version
```

### Running code from file

```
ram run file.ram 1 2 3 4
```

## Roadmap for v1

- [x] Automatic changelog
- [x] Cargo crate with automatic publish to crates.io
- [x] Use clap to parse args
- [ ] Repl
- [ ] Debug mode
- [ ] Use clap to parse args

0 comments on commit cd60242

Please sign in to comment.