Code blocks in the README file have copy buttons. These copy actions also copy the $ signs. The unattentive reader might click the copy button, paste into the terminal and get -bash: $: command not found. The code can be copied more easily if the $ signs are removed. Instead, indication that the code is bash/shell should be given by adding the correct language to the code block.
E.g. instead of
$ pip install something
this can be used:
```bash
pip install something
For code blocks which also show the output, I think you could split them into two blocks: One with the code, one with the output. Though I'm not sure if this would be a great solution.
psteinb
commented
2 years ago
Code blocks in the README file have copy buttons. These copy actions also copy the
$signs. The unattentive reader might click the copy button, paste into the terminal and get-bash: $: command not found. The code can be copied more easily if the$signs are removed. Instead, indication that the code is bash/shell should be given by adding the correct language to the code block.E.g. instead of
$ pip install something
this can be used: