piotrmurach / tty

Toolkit for developing sleek command line apps.
https://ttytoolkit.org
MIT License
2.5k stars 78 forks source link

clarify the need to `cd` before running `teletype` commands in the 'Overview' section of the README #71

Closed slowbro closed 3 years ago

slowbro commented 3 years ago

Describe the change

Related to #62 - clarify that one must be in the app directory before commands can be added.

Why are we doing this?

The documentation makes it seem like one would immediately run teletype command ... after making an app, without being in the app directory itself.

Benefits

More detailed docs!

Drawbacks

None that I can think of.

Requirements

Put an X between brackets on each line if you have done the item: [n/a] Tests written & passing locally? [x] Code style checked? [x] Rebased with master branch? [x] Documentaion updated?

piotrmurach commented 3 years ago

Thank you! ❤️