search

testdouble / teenytest

A very simple, zero-config test runner for Node.js
MIT License
96 stars 14 forks source link

Update README.md #36

Closed kscoulter closed 6 years ago

kscoulter commented 6 years ago

An extra $ sign is confusing because it is also used in the variable declaration $(npm bin). As a new user to this library I copy/pasted the entire expression, but the $ threw an exception.

davemo commented 6 years ago

Hey @searls, I've been pairing with @kscoulter on some node fundamentals. I didn't realize how this might be confusing to new users who could copy/paste the entire $ npm install directive in the documentation. I think this is a good improvement :)

searls commented 6 years ago

Sure, I'm fine with this. For what it's worth, because the Internet is full of markdown code fences that use $ prefixes to indicate a prompt, you can make them copy-paste friendly in your terminal by adding a custom script to your PATH. In my ~/bin directory, I wrote a script named ~/bin/$:

#!/bin/bash
"$@"

This basically just ignores leading $ … characters and runs whatever comes after. Saves me a lot of time when I'm too lazy or imprecise to copy-paste everything I need from a README perfectly.