jonschlinkert / grunt-readme

DEPRECATED. Use Verb instead
https://github.com/assemble/verb
Other
30 stars 10 forks source link

Not reading the template file when set correct #50

Closed nkapatos closed 10 years ago

nkapatos commented 10 years ago

If I use this in my configuration

readme: {
      options: {
        readme: 'docs/README.tmpl.md'
      }
    }

It will create the README.md with the default template instead the one I want it to use. Like the file I put in the path does not exist. If I remove the readme configuration or make a typo, then it will load the template which is in docs/ and I wanted to use in the first place.

doowb commented 10 years ago

It looks like there is some code missing that's causing this bug. It should be a quick fix, but it would be nice to create a unit test around it showing how it breaks first.

@jonschlinkert what's the status with grunt-readme now that phaser has been released?

edit - github must have been slow and I double posted.

jonschlinkert commented 10 years ago

what's the status with grunt-readme now that phaser has been released?

I think what I'm going to do is just refactor this to use Phaser, but I'll add some defaults and templates specifically for building the readme. That, or just deprecate it and use grunt-phaser. thoughts?

doowb commented 10 years ago

add some defaults and templates specifically for building the readme

That's a good point. I think that we can refactor to use phase and keep it around and add to the documentation that phaser and grunt-phaser is available for documentation that extends further than just a README.md

nkapatos commented 10 years ago

So, you are going to discontinue grunt-readme and move on with grunt-phaser (star trek music in the background)....

doowb commented 10 years ago

No, we'll keep grunt-readme just for README.md files.

jonschlinkert commented 10 years ago

Sorry it has been so extremely long since this was addressed!

grunt-phaser (star trek music in the background)....

I so badly wanted to name it that lol. But, we settled on the name Verb instead. We published both grunt and gulp tasks, a cli and a generator. It does what grunt-readme does, but super easy to use (requiring zero config) and waaaay more powerful for anyone who wants more than the defaults.

Hope you like it!