Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve hermit help output #75

Open
reillysiemens opened this issue May 30, 2015 · 4 comments
Open

Improve hermit help output #75

reillysiemens opened this issue May 30, 2015 · 4 comments

Comments

@reillysiemens
Copy link
Collaborator

The output of a raw hermit or hermit help looks like

Hermit 0.1.0
Usage: hermit <command> [<args>]

Some useful hermit commands are:
   commands    List all available hermit commands
   init        Start a new hermit profile
   clone       Create a local hermit from an existing remote hermit
   status      Display the status of your hermit
   use         Switch to using a different profile
   add         Add files to your hermit directory
   update      Update redacted files already stored in git

See `hermit help <command>' for information on a specific command.
For full documentation, see: https://github.com/radicalzephyr/hermit#readme

By contrast, the output of a raw nvm or nvm help looks like

Node Version Manager

Usage:
  nvm help                              Show this message
  nvm --version                         Print out the latest released version of nvm
  nvm install [-s] <version>            Download and install a <version>, [-s] from source. Uses .nvmrc if available
  nvm uninstall <version>               Uninstall a version
  nvm use <version>                     Modify PATH to use <version>. Uses .nvmrc if available
  nvm run <version> [<args>]            Run <version> with <args> as arguments. Uses .nvmrc if available for <version>
  nvm current                           Display currently activated version
  nvm ls                                List installed versions
  nvm ls <version>                      List versions matching a given description
  nvm ls-remote                         List remote versions available for install
  nvm deactivate                        Undo effects of `nvm` on current shell
  nvm alias [<pattern>]                 Show all aliases beginning with <pattern>
  nvm alias <name> <version>            Set an alias named <name> pointing to <version>
  nvm unalias <name>                    Deletes the alias named <name>
  nvm reinstall-packages <version>      Reinstall global `npm` packages contained in <version> to current version
  nvm unload                            Unload `nvm` from shell
  nvm which [<version>]                 Display path to installed node version. Uses .nvmrc if available

Example:
  nvm install v0.10.32                  Install a specific version number
  nvm use 0.10                          Use the latest available 0.10.x release
  nvm run 0.10.32 app.js                Run app.js using node v0.10.32
  nvm exec 0.10.32 node app.js          Run `node app.js` with the PATH pointing to node v0.10.32
  nvm alias default 0.10.32             Set default node version on a shell

Note:
  to remove, delete, or uninstall nvm - just remove ~/.nvm, ~/.npm, and ~/.bower folders

I think the extra spacing makes it easier to read and the Example and Note sections are probably really useful to first time users.

I don't think it would take too much effort to spruce up what's essentially the landing page of this program.

@reillysiemens
Copy link
Collaborator Author

The output of a raw hermit or hermit help now looks like this:

Hermit 0.1.0-alpha2-15-g55b6f3d
Usage: hermit <command> [<args>]

Some useful hermit commands are:
   hermit commands        List all available hermit commands
   hermit init            Start a new hermit profile
   hermit clone           Create a local hermit from an existing remote hermit
   hermit status          Display the status of your hermit
   hermit use             Switch to using a different profile
   hermit add             Add files to your hermit directory
   hermit update          Update redacted files already stored in git
   hermit git             Run git operations on current profile repository

See `hermit help <command>' for information on a specific command.
For full documentation, see: https://github.com/radicalzephyr/hermit#readme

That looks pretty good to me. Do we just want an examples section now?

@RadicalZephyr
Copy link
Collaborator

Your issue sir :) Examples would probably be a good thing to add though.

@reillysiemens
Copy link
Collaborator Author

I'll be satisfied after there's an examples section. I'll go ahead and add that and then this could get closed.

@reillysiemens reillysiemens self-assigned this Jun 13, 2015
@reillysiemens
Copy link
Collaborator Author

This is still waiting on some examples, so let's kill #66 and get some tutorials written.

@RadicalZephyr RadicalZephyr modified the milestones: beta, 1.0 Dec 31, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants