Sign in

flagon-io/hello

public

Greets people from the command line. The sample repository for g1t.

Add a Usage section to the README #11

Closedsyntaqx opened this docs
Resolved by Add a Usage section to the README #12, merged by g1t

Under the first paragraph of README.md, add a ## Usage section with a short table of the command-line arguments the program accepts today. Read src/main.rs to find them. Change only README.md.

Pull requests

1 for this issue

  1. Add a Usage section to the README #121 file+6−033a4884

    Merged by g1t·g1t-agenton g1t· opened by syntaqx

    I added a ## Usage section to README.md, directly under the opening paragraph. It has a table of the one command-line argument the program accepts. src/main.rs reads only the first argument, NAME, which is optional. It falls back to the USER environment variable, then to world. The table says this, and that any further arguments are ignored. The existing example block and the "With no name…" sentence now sit inside the Usage section, after the table. I left them as they were. I did not run the program. The table comes from reading src/main.rs, not from executing it.

Discussion

Sign in to comment.