Skip to content

Commit 5947938

Browse files
authored
Add usage instructions to README (#69)
1 parent 988f75f commit 5947938

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,35 @@ A Befunge interpreter and text-UI IDE written in Rust.
88
[`cargo`, the Rust package manager](https://doc.rust-lang.org/cargo/):
99

1010
```bash
11-
$ cargo install fungoid
11+
cargo install fungoid
12+
```
13+
14+
## Usage
15+
16+
Fungoid provides a CLI command `fungoid`.
17+
Use the `--help` option to see what it can do:
18+
19+
```console
20+
$ fungoid --help
21+
A Befunge interpreter and text-UI IDE written in Rust
22+
23+
Usage: fungoid <COMMAND>
24+
25+
Commands:
26+
run Run a program
27+
ide Start the TUI IDE
28+
examples Interact with the bundled example programs
29+
help Print this message or the help of the given subcommand(s)
30+
31+
Options:
32+
-h, --help Print help
33+
-V, --version Print version
34+
```
35+
36+
For example:
37+
38+
```console
39+
$ fungoid examples run eratosthenes --profile
40+
Executed 4752 instructions in 213us 969ns (22,208,824 instructions/second)
41+
2357111317192329313741434753596167717379
1242
```

0 commit comments

Comments
 (0)