Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hlorenzi committed Feb 21, 2020
1 parent 27687bb commit 65e4d79
Showing 1 changed file with 32 additions and 19 deletions.
51 changes: 32 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@ This can be useful if you'd like to test out a new virtual machine's bytecode,
or even if you're eager to write programs for that new processor architecture
you just implemented in FPGA!

[![Latest Release][badge-latest-img]][badge-latest-url]
[![Releases][badge-downloads-img]][badge-downloads-url]
[![Discord][badge-discord-img]][badge-discord-url]

[badge-latest-img]: https://img.shields.io/github/v/release/hlorenzi/customasm
[badge-latest-url]: https://github.com/hlorenzi/customasm/releases

[badge-downloads-img]: https://img.shields.io/github/downloads/hlorenzi/customasm/total
[badge-downloads-url]: https://github.com/hlorenzi/customasm/releases

[badge-discord-img]: https://img.shields.io/discord/394999035540275222?label=Discord&logo=discord
[badge-discord-url]: https://discord.gg/JYbhDtp

[📱 Try it right now in your browser!](https://hlorenzi.github.io/customasm/web/)

[🎁 Check out the Releases section](https://github.com/hlorenzi/customasm/releases)
Expand All @@ -20,25 +33,6 @@ on how to use the main features!
You can compile from source by simply doing `cargo build`. There's also a
battery of tests available at `cargo test`.

## Command Line Usage

```
Usage: customasm [options] <asm-file-1> ... <asm-file-N>
Options:
-f, --format FORMAT The format of the output file. Possible formats:
binary, annotated, annotatedbin, binstr, hexstr,
bindump, hexdump, mif, intelhex, deccomma, hexcomma,
decc, hexc, logisim8, logisim16
-o, --output FILE The name of the output file.
-s, --symbol FILE The name of the output symbol file.
-p, --print Print output to stdout instead of writing to a file.
-q, --quiet Suppress progress reports.
-v, --version Display version information.
-h, --help Display this information.
```

## Example

Given the following file:
Expand Down Expand Up @@ -87,3 +81,22 @@ multiply3x4:
109:0 | 109 | 40 01 06 ; jnz .loop
10c:0 | 10c | 50 ; ret
```

## Command Line Usage

```
Usage: customasm [options] <asm-file-1> ... <asm-file-N>
Options:
-f, --format FORMAT The format of the output file. Possible formats:
binary, annotated, annotatedbin, binstr, hexstr,
bindump, hexdump, mif, intelhex, deccomma, hexcomma,
decc, hexc, logisim8, logisim16
-o, --output FILE The name of the output file.
-s, --symbol FILE The name of the output symbol file.
-p, --print Print output to stdout instead of writing to a file.
-q, --quiet Suppress progress reports.
-v, --version Display version information.
-h, --help Display this information.
```

0 comments on commit 65e4d79

Please sign in to comment.