Trying the nix CLI today, and I'm seriously impressed with the formatting of its --help output.
Indented warnings, italics, bullets, even adding a left border to code snippets! It's a nice reminder to take full advantage of terminal features to help the reader.
Related Posts
I'm trying to improve the readability of the --help output from difftastic.
I'm experimenting with making example invocations bold, so they are easier to distinguish from the text.
I'm also trying OSC 8 to make my URLs clickable.
Opinions welcome :)
I'm designing a programming language and trying to decide the type of `let x = 1;`. Should it be Unit or Int?
Advantage of Int: really convenient when evaluating snippets in a REPL.
Advantage of Unit: It's much less confusing when type inference runs on an incomplete function.
It is *really* hard to find a good screenshot for a CLI tool when users are on a mobile browser.
This is the best I've come up with so far. I'm showing the terminal GUI to show where you'd use the tool.
I'm also trying several standalone screenshots to make it more comprehensible.