lukeed / generator-taskr

Official Yeoman generator for Taskr
25 stars 2 forks source link

Create USAGE #3

Closed sotayamashita closed 9 years ago

hzlmn commented 9 years ago

I'm not really sure why we need this, we have the description on the main page? Also, if it necessary it should be as a markdown file. @bucaran ?

sotayamashita commented 9 years ago

@drKraken When user run command, you cannot get help for it. For Example, generator-generator also has a USAGE so it will show the help.

$ yo generator --help                                                                                                                                                                                                          
Usage:
  yo generator:app [options]

Options:
  -h,   --help        # Print the generator's options and usage
        --skip-cache  # Do not remember prompt answers  Default: false
        --flat        # When specified, generators will be created at the top level of the project.  Default: false

Description:
    Creates a basic Yeoman generator to scaffold an application

Example:
    yo generator

    This will create:
        README.md: Description and minimal user instructions
        package.json: Development packages installed by npm

        app/index.js: Main generator script
        app/templates/: Templates for files created by your generator
        test/: Unit tests for your generator
ghost commented 9 years ago

@sotayamashita Thanks! I like this, but I want to keep the README simple too!

Question:
  1. Do you mean adding a CLI option to the generator to show usage? :+1:
  2. Or do you mean add it to the README.md / USAGE.md. If that's the case, what do you think about putting it in the Wiki.

EDIT: I didn't understand the PR, hence the question. Nevermind the above questions and thanks for your contribution.

ghost commented 9 years ago

@sotayamashita Oh, I understand now, good job and thanks! :+1:

ghost commented 9 years ago

@drKraken See this.

sotayamashita commented 9 years ago

I'm sorry not enough words. Thank you