search

18F / laptop

DEPRECATED: A shell script which turns your Mac into an awesome web development machine.
https://github.com/18F/handbook/pull/2186
Other
316 stars 91 forks source link

Suggestions for language for making the script interactive #41

Open brittag opened 8 years ago

brittag commented 8 years ago

Suggestions for a helpful style of interactive language for when the script is split into conceptual/task-oriented sections:

If you plan to work on Python projects, we recommend this set of tools to get a flexible development environment set up quickly. This includes: pyenv (for managing Python versions if you do not have Python already installed; includes the latest 3.x Python), virtualenv (for creating isolated Python environments; via pyenv if it is installed), and virtualenvwrapper (for extending Virtualenv; via pyenv if it is installed). Want to install this set? y/n

Or:

If you don’t already have a favorite set of OS X apps for doing development work, we have some recommendations. This includes: Sublime Text (a nice text editor), f.lux (for adjusting your Mac's display color so you can sleep better), GitHub Desktop (for setting up your SSH keys automatically), CloudApp (for sharing screenshots and making an animated GIF from a video), and The Silver Searcher (for finding things in files). Want to install this set? y/n

Or:

OS X comes set up with bash as the default shell, which works fine for development. Some of us like using zsh, which is less common but has some extra features for customization and tab completion. Want to switch your shell to zsh? (If you're not sure, sticking with bash is fine.) y/n

The idea would be: start each set by explaining the problem that it solves, list what it installs (and what each tool is for), make it clear that they're recommendations, and end the description by asking yes/no.

Ideally, make each set description and tool description match the descriptions on this readme, and make the sets line up with a corresponding page of more detailed documentation when possible (such as the Python set lining up with the Python dev environment guide). Link to the matching documentation from the readme.

melodykramer commented 8 years ago

I really like this. Can the app play around with spacing, so it's not a block of text? Bolding the tools would help the user differentiate each piece.