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.
Related Posts
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.
I'm trying to decide what program I should show on the home page of my PL.
Hello World is too simple to show much syntax. Fibonacci is OK but the reader may not know what print(fib(10)) should show.
Maybe print(greet("World")) is better? It gives you a function definition at least.
I'm trying to decide the best voice for PL documentation.
Passive: "`let` can be used with destructuring."
Reader focused: "You can use `let` with destructuring."
Describing the PL: "FooLang supports destructuring with `let`."
Anyone have opinions or best practices?
