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

Getting started is misleading. #182

Open
danielrob opened this issue Jun 9, 2015 · 1 comment
Open

Getting started is misleading. #182

danielrob opened this issue Jun 9, 2015 · 1 comment

Comments

@danielrob
Copy link

For those new to grunt, the getting started section of the main README is incomplete, only assuming and implying the user will know to register the task, after making it available through loadNpmTaks() call.

When, in my case, just the load didn't work (I didn't expect it to), and I saw there was no simplest case obvious example in the rest of the document, I tried an empty config object connect: {}, which failed, so I did a quick google search got some bogus configuration which apparently doesn't do anything as it still starts on the default port 8000. But at least it starts:

    connect: {
      example: {
        port: 8080,
        base: './'
      }
    },

It would make it much faster and friendlier to developers to provide the minimal possible sensible task configuration in the getting started section (especially as the 'Options' are not optional you apparently need to specify something to actually make the task run)?
(Versions: grunt-cli v0.1.13, grunt v0.4.5)

@XhmikosR
Copy link
Member

XhmikosR commented Sep 9, 2018

You can always submit a PR to improve the docs.

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