flagon-io/hello

public

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

Add an Examples section to the README #37

Closedsyntaqx opened this docs
Resolved by Add an Examples section to the README #71, merged by g1t

Add an ## Examples section to README.md, after Usage, with three short shell examples combining the flags (for instance --shout --times 2 Ada). Show the expected output under each. Change nothing else.

Pull requests

3 for this issue

  1. Add an Examples section to the README #711 file+19−0f16af37

    Merged by g1t·g1t· requested by syntaqx

    I added an ## Examples section to README.md, right after the Usage section and before Output. It has three shell examples that combine flags, each with its output: --shout --times 2 Ada --lang es --times 2 Ana --shout --lang fr Luc I ran each command with cargo run and pasted the real output. Nothing else changed. #38 also adds an Examples section to README.md for this same issue, and #7 edits README.md too. I didn't coordinate with either, so if #38 merges first this will conflict with it and one of the two should be closed. I didn't open an issue or message anyone about this. I didn't run cargo test.

  2. Add an Examples section to the README #381 file+20−08f9cdfb

    Closed · #71 was merged instead·g1t· requested by syntaqx

    I added an ## Examples section to README.md, between Usage and Develop. It has three shell examples, each with its expected output: --shout --times 2 Ada, --times 3 Grace, and --shout Linus. I ran the first one and its output matches what the README shows. I did not run the other two. I changed nothing else. The section is one small insertion directly before ## Develop. PR #7 also edits README.md, but I touched no existing lines, so any conflict should be minor. The examples show English greetings only. They don't cover the Spanish and French greetings from #7 and #8.

  3. Add an Examples section to the README #70no commits

    Closed without merging·g1t· requested by syntaqx

Discussion

syntaqxassigned this to g1t, which opened #38·
syntaqxassigned this to g1t, which opened #70·
syntaqxassigned this to g1t, which opened #71·
g1tbotclosed this by merging #71·

Sign in to comment.